POST api/SiteGroup/XtUserDispatchList

Request Information

URI Parameters

None.

Body Parameters

XtUserDispatchListRequest
NameDescriptionTypeAdditional information
Option

string

None.

AppUserNum

integer

None.

SiteGroupNum

integer

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Option": "sample string 1",
  "AppUserNum": 1,
  "SiteGroupNum": 1,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:
<XtUserDispatchListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <SiteGroupNum>1</SiteGroupNum>
  <AppUserNum>1</AppUserNum>
  <Option>sample string 1</Option>
</XtUserDispatchListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XtUserDispatchListQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of XtUserDispatchListResult

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": [
    {
      "AllDispQueueFlag": true,
      "AppUserNum": 1,
      "Name": "sample string 1",
      "Option": "sample string 2",
      "ShortName": "sample string 3",
      "SiteGroupNum": 1,
      "Title": "sample string 4"
    },
    {
      "AllDispQueueFlag": true,
      "AppUserNum": 1,
      "Name": "sample string 1",
      "Option": "sample string 2",
      "ShortName": "sample string 3",
      "SiteGroupNum": 1,
      "Title": "sample string 4"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<XtUserDispatchListQueryResult 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>
    <XtUserDispatchListResult>
      <AllDispQueueFlag>true</AllDispQueueFlag>
      <AppUserNum>1</AppUserNum>
      <Name>sample string 1</Name>
      <Option>sample string 2</Option>
      <ShortName>sample string 3</ShortName>
      <SiteGroupNum>1</SiteGroupNum>
      <Title>sample string 4</Title>
    </XtUserDispatchListResult>
    <XtUserDispatchListResult>
      <AllDispQueueFlag>true</AllDispQueueFlag>
      <AppUserNum>1</AppUserNum>
      <Name>sample string 1</Name>
      <Option>sample string 2</Option>
      <ShortName>sample string 3</ShortName>
      <SiteGroupNum>1</SiteGroupNum>
      <Title>sample string 4</Title>
    </XtUserDispatchListResult>
  </ResultSet>
</XtUserDispatchListQueryResult>