POST api/Query?APIGUID={APIGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
APIGUID		string	Required

Body Parameters

ParameterList

Name	Type	Additional information
VendorID	string	None.
VendorPassword	string	None.
QueryTemplateName	string	None.
CompanyKey	Collection of integer	None.
CommunityKey	Collection of integer	None.
UnitKey	integer	None.
ResidentKey	Collection of integer	None.
ResidentContactKey	Collection of integer	None.
GLAccountKey	integer	None.
VendorKey	integer	None.
VendorLocationKey	integer	None.
BeginDate	date	None.
EndDate	date	None.
StatementDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "VendorID": "sample string 1",
  "VendorPassword": "sample string 2",
  "QueryTemplateName": "sample string 3",
  "CompanyKey": [
    1,
    2
  ],
  "CommunityKey": [
    1,
    2
  ],
  "UnitKey": 4,
  "ResidentKey": [
    1,
    2
  ],
  "ResidentContactKey": [
    1,
    2
  ],
  "GLAccountKey": 5,
  "VendorKey": 6,
  "VendorLocationKey": 7,
  "BeginDate": "2024-09-19T12:26:03.7537854-05:00",
  "EndDate": "2024-09-19T12:26:03.7537854-05:00",
  "StatementDate": "2024-09-19T12:26:03.7537854-05:00"
}

application/xml, text/xml

Sample:

<ParameterList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesSystem">
  <BeginDate>2024-09-19T12:26:03.7537854-05:00</BeginDate>
  <CommunityKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CommunityKey>
  <CompanyKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CompanyKey>
  <EndDate>2024-09-19T12:26:03.7537854-05:00</EndDate>
  <GLAccountKey>5</GLAccountKey>
  <QueryTemplateName>sample string 3</QueryTemplateName>
  <ResidentContactKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResidentContactKey>
  <ResidentKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResidentKey>
  <StatementDate>2024-09-19T12:26:03.7537854-05:00</StatementDate>
  <UnitKey>4</UnitKey>
  <VendorID>sample string 1</VendorID>
  <VendorKey>6</VendorKey>
  <VendorLocationKey>7</VendorLocationKey>
  <VendorPassword>sample string 2</VendorPassword>
</ParameterList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.