POST api/Site/XmitCodeList
Request Information
URI Parameters
None.
Body Parameters
XmitCodeListRequestName | Description | Type | Additional information |
---|---|---|---|
Prefix | string |
None. |
|
SubscriberStart | integer |
None. |
|
SubscriberMax | integer |
None. |
|
FunctionName | string |
None. |
|
SiteGroupSearch | string |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Prefix": "sample string 1", "SubscriberStart": 1, "SubscriberMax": 1, "FunctionName": "sample string 2", "SiteGroupSearch": "sample string 3", "SessionNum": 4, "SessionPassword": "QEA=", "ApplicationCode": "sample string 5", "StagesURL": "sample string 6" }
application/xml, text/xml
Sample:
<XmitCodeListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 6</StagesURL> <ApplicationCode>sample string 5</ApplicationCode> <SessionNum>4</SessionNum> <SessionPassword>QEA=</SessionPassword> <FunctionName>sample string 2</FunctionName> <Prefix>sample string 1</Prefix> <SiteGroupSearch>sample string 3</SiteGroupSearch> <SubscriberMax>1</SubscriberMax> <SubscriberStart>1</SubscriberStart> </XmitCodeListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XmitCodeListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XmitCodeListResult |
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": [ { "FunctionName": "sample string 1", "Prefix": "sample string 2", "SubscriberMax": 1, "SubscriberStart": 1, "TransmitterCode": "sample string 3", "SiteGroupName": "sample string 4", "SiteGroupSearch": "sample string 5" }, { "FunctionName": "sample string 1", "Prefix": "sample string 2", "SubscriberMax": 1, "SubscriberStart": 1, "TransmitterCode": "sample string 3", "SiteGroupName": "sample string 4", "SiteGroupSearch": "sample string 5" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XmitCodeListQueryResult 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> <XmitCodeListResult> <FunctionName>sample string 1</FunctionName> <Prefix>sample string 2</Prefix> <SiteGroupName>sample string 4</SiteGroupName> <SiteGroupSearch>sample string 5</SiteGroupSearch> <SubscriberMax>1</SubscriberMax> <SubscriberStart>1</SubscriberStart> <TransmitterCode>sample string 3</TransmitterCode> </XmitCodeListResult> <XmitCodeListResult> <FunctionName>sample string 1</FunctionName> <Prefix>sample string 2</Prefix> <SiteGroupName>sample string 4</SiteGroupName> <SiteGroupSearch>sample string 5</SiteGroupSearch> <SubscriberMax>1</SubscriberMax> <SubscriberStart>1</SubscriberStart> <TransmitterCode>sample string 3</TransmitterCode> </XmitCodeListResult> </ResultSet> </XmitCodeListQueryResult>