POST api/SiteGroup/XtDispatchQueueStatistics

Request Information

URI Parameters

None.

Body Parameters

XtDispatchQueueStatisticsRequest
NameDescriptionTypeAdditional information
DispatchQueue

string

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<XtDispatchQueueStatisticsRequest 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>
  <DispatchQueue>sample string 1</DispatchQueue>
</XtDispatchQueueStatisticsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XtDispatchQueueStatisticsQueryResult
NameDescriptionTypeAdditional information
ResultSet

Collection of XtDispatchQueueStatisticsResult

None.

ErrorTypeNum

integer

None.

UserErrorMessage

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultSet": [
    {
      "DispQueue": "sample string 1",
      "Description": "sample string 2",
      "DelayedAlarmCount": 1,
      "AlarmCount": 1,
      "AlarmAvailableCount": 1,
      "AlarmLockedCount": 1,
      "AlarmOldest": "sample string 3",
      "AlarmOldestAvailable": "sample string 4",
      "AlarmOldestLocked": "sample string 5"
    },
    {
      "DispQueue": "sample string 1",
      "Description": "sample string 2",
      "DelayedAlarmCount": 1,
      "AlarmCount": 1,
      "AlarmAvailableCount": 1,
      "AlarmLockedCount": 1,
      "AlarmOldest": "sample string 3",
      "AlarmOldestAvailable": "sample string 4",
      "AlarmOldestLocked": "sample string 5"
    }
  ],
  "ErrorTypeNum": 1,
  "UserErrorMessage": "sample string 2",
  "Success": true
}

application/xml, text/xml

Sample:
<XtDispatchQueueStatisticsQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI">
  <ErrorTypeNum>1</ErrorTypeNum>
  <ResultSet>
    <XtDispatchQueueStatisticsResult>
      <AlarmAvailableCount>1</AlarmAvailableCount>
      <AlarmCount>1</AlarmCount>
      <AlarmLockedCount>1</AlarmLockedCount>
      <AlarmOldest>sample string 3</AlarmOldest>
      <AlarmOldestAvailable>sample string 4</AlarmOldestAvailable>
      <AlarmOldestLocked>sample string 5</AlarmOldestLocked>
      <DelayedAlarmCount>1</DelayedAlarmCount>
      <Description>sample string 2</Description>
      <DispQueue>sample string 1</DispQueue>
    </XtDispatchQueueStatisticsResult>
    <XtDispatchQueueStatisticsResult>
      <AlarmAvailableCount>1</AlarmAvailableCount>
      <AlarmCount>1</AlarmCount>
      <AlarmLockedCount>1</AlarmLockedCount>
      <AlarmOldest>sample string 3</AlarmOldest>
      <AlarmOldestAvailable>sample string 4</AlarmOldestAvailable>
      <AlarmOldestLocked>sample string 5</AlarmOldestLocked>
      <DelayedAlarmCount>1</DelayedAlarmCount>
      <Description>sample string 2</Description>
      <DispQueue>sample string 1</DispQueue>
    </XtDispatchQueueStatisticsResult>
  </ResultSet>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
</XtDispatchQueueStatisticsQueryResult>