POST api/SiteGroup/XtSiteGroupList
Request Information
URI Parameters
None.
Body Parameters
SessionRequestName | Description | Type | Additional information |
---|---|---|---|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<SessionRequest 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> </SessionRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtSiteGroupListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtSiteGroupListResult |
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", "City": "sample string 2", "Phone": "sample string 3", "SiteGroupName": "sample string 4", "SiteGroupNum": 1, "SiteGroupSuspendFlag": "sample string 5", "SiteGroupType": "sample string 6", "SiteGroupTypeDescription": "sample string 7", "State": "sample string 8", "StreetName": "sample string 9", "ZipCode": "sample string 10" }, { "Address": "sample string 1", "City": "sample string 2", "Phone": "sample string 3", "SiteGroupName": "sample string 4", "SiteGroupNum": 1, "SiteGroupSuspendFlag": "sample string 5", "SiteGroupType": "sample string 6", "SiteGroupTypeDescription": "sample string 7", "State": "sample string 8", "StreetName": "sample string 9", "ZipCode": "sample string 10" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtSiteGroupListQueryResult 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> <XtSiteGroupListResult> <Address>sample string 1</Address> <City>sample string 2</City> <Phone>sample string 3</Phone> <SiteGroupName>sample string 4</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSuspendFlag>sample string 5</SiteGroupSuspendFlag> <SiteGroupType>sample string 6</SiteGroupType> <SiteGroupTypeDescription>sample string 7</SiteGroupTypeDescription> <State>sample string 8</State> <StreetName>sample string 9</StreetName> <ZipCode>sample string 10</ZipCode> </XtSiteGroupListResult> <XtSiteGroupListResult> <Address>sample string 1</Address> <City>sample string 2</City> <Phone>sample string 3</Phone> <SiteGroupName>sample string 4</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSuspendFlag>sample string 5</SiteGroupSuspendFlag> <SiteGroupType>sample string 6</SiteGroupType> <SiteGroupTypeDescription>sample string 7</SiteGroupTypeDescription> <State>sample string 8</State> <StreetName>sample string 9</StreetName> <ZipCode>sample string 10</ZipCode> </XtSiteGroupListResult> </ResultSet> </XtSiteGroupListQueryResult>