POST api/SiteGroup/XtUserDispatchUpdate
Request Information
URI Parameters
None.
Body Parameters
XtUserDispatchUpdateRequestName | Description | Type | Additional information |
---|---|---|---|
AllDispatchQueuesFlag | boolean |
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:
{ "AllDispatchQueuesFlag": true, "AppUserNum": 1, "SiteGroupNum": 1, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<XtUserDispatchUpdateRequest 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> <AppUserNum>1</AppUserNum> <AllDispatchQueuesFlag>true</AllDispatchQueuesFlag> </XtUserDispatchUpdateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtUserDispatchUpdateQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtUserDispatchUpdateResult |
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, "FirstName": "sample string 1", "LastName": "sample string 2", "LoggedInFlag": true, "SiteGroupNum": 1, "ShortName": "sample string 3" }, { "AllDispQueueFlag": true, "AppUserNum": 1, "FirstName": "sample string 1", "LastName": "sample string 2", "LoggedInFlag": true, "SiteGroupNum": 1, "ShortName": "sample string 3" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtUserDispatchUpdateQueryResult 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> <XtUserDispatchUpdateResult> <AllDispQueueFlag>true</AllDispQueueFlag> <AppUserNum>1</AppUserNum> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <LoggedInFlag>true</LoggedInFlag> <ShortName>sample string 3</ShortName> <SiteGroupNum>1</SiteGroupNum> </XtUserDispatchUpdateResult> <XtUserDispatchUpdateResult> <AllDispQueueFlag>true</AllDispQueueFlag> <AppUserNum>1</AppUserNum> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <LoggedInFlag>true</LoggedInFlag> <ShortName>sample string 3</ShortName> <SiteGroupNum>1</SiteGroupNum> </XtUserDispatchUpdateResult> </ResultSet> </XtUserDispatchUpdateQueryResult>