POST api/Search/SiteGroupSearch
Request Information
URI Parameters
None.
Body Parameters
SiteGroupNumRequestName | Description | Type | Additional information |
---|---|---|---|
SiteGroupNum | integer |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SiteGroupNum": 1, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<SiteGroupNumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 3</StagesURL> <ApplicationCode>sample string 2</ApplicationCode> <SessionNum>1</SessionNum> <SessionPassword>QEA=</SessionPassword> <SiteGroupNum>1</SiteGroupNum> </SiteGroupNumRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteGroupSearchQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of SiteGroupSearchResult |
None. |
|
Success | boolean |
None. |
|
UserErrorMessage | string |
None. |
|
ErrorTypeNum | integer |
None. |
|
SqlConnectionLost | boolean |
None. |
|
ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ExcludeColumnList": [ "sample string 1", "sample string 2" ], "ResultSet": [ { "Address": "sample string 1", "BillingID": "sample string 2", "City": "sample string 3", "HighlightFlag": true, "Option": "sample string 4", "Phone": "sample string 5", "SiteGroupName": "sample string 6", "SiteGroupNum": 1, "SiteGroupSuspendFlag": "sample string 7", "SiteGroupType": "sample string 8", "SiteGroupTypeDescription": "sample string 9", "State": "sample string 10", "StreetName": "sample string 11", "ZipCode": "sample string 12", "SupportRep": "sample string 13", "UDFCode": "sample string 14", "UDFValue": "sample string 15", "SiteGroupNamePlusNum": "sample string 16" }, { "Address": "sample string 1", "BillingID": "sample string 2", "City": "sample string 3", "HighlightFlag": true, "Option": "sample string 4", "Phone": "sample string 5", "SiteGroupName": "sample string 6", "SiteGroupNum": 1, "SiteGroupSuspendFlag": "sample string 7", "SiteGroupType": "sample string 8", "SiteGroupTypeDescription": "sample string 9", "State": "sample string 10", "StreetName": "sample string 11", "ZipCode": "sample string 12", "SupportRep": "sample string 13", "UDFCode": "sample string 14", "UDFValue": "sample string 15", "SiteGroupNamePlusNum": "sample string 16" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteGroupSearchQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages"> <ClientVersion>sample string 5</ClientVersion> <ErrorTypeNum>3</ErrorTypeNum> <SqlConnectionLost>true</SqlConnectionLost> <Success>true</Success> <UserErrorMessage>sample string 2</UserErrorMessage> <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ExcludeColumnList> <ResultSet> <SiteGroupSearchResult> <Address>sample string 1</Address> <BillingID>sample string 2</BillingID> <City>sample string 3</City> <HighlightFlag>true</HighlightFlag> <Option>sample string 4</Option> <Phone>sample string 5</Phone> <SiteGroupName>sample string 6</SiteGroupName> <SiteGroupNamePlusNum>sample string 16</SiteGroupNamePlusNum> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSuspendFlag>sample string 7</SiteGroupSuspendFlag> <SiteGroupType>sample string 8</SiteGroupType> <SiteGroupTypeDescription>sample string 9</SiteGroupTypeDescription> <State>sample string 10</State> <StreetName>sample string 11</StreetName> <SupportRep>sample string 13</SupportRep> <UDFCode>sample string 14</UDFCode> <UDFValue>sample string 15</UDFValue> <ZipCode>sample string 12</ZipCode> </SiteGroupSearchResult> <SiteGroupSearchResult> <Address>sample string 1</Address> <BillingID>sample string 2</BillingID> <City>sample string 3</City> <HighlightFlag>true</HighlightFlag> <Option>sample string 4</Option> <Phone>sample string 5</Phone> <SiteGroupName>sample string 6</SiteGroupName> <SiteGroupNamePlusNum>sample string 16</SiteGroupNamePlusNum> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSuspendFlag>sample string 7</SiteGroupSuspendFlag> <SiteGroupType>sample string 8</SiteGroupType> <SiteGroupTypeDescription>sample string 9</SiteGroupTypeDescription> <State>sample string 10</State> <StreetName>sample string 11</StreetName> <SupportRep>sample string 13</SupportRep> <UDFCode>sample string 14</UDFCode> <UDFValue>sample string 15</UDFValue> <ZipCode>sample string 12</ZipCode> </SiteGroupSearchResult> </ResultSet> </SiteGroupSearchQueryResult>