POST api/DEW/GetDERQueueSummary

Request Information

URI Parameters

None.

Body Parameters

DewSummaryRequest
NameDescriptionTypeAdditional information
Username

string

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<DewSummaryRequest 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>
  <Username>sample string 1</Username>
</DewSummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetDERQueueSummaryResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

QueueSummary

Collection of pGetDERQueueSummaryResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "QueueSummary": [
    {
      "queueName": "sample string 1",
      "queueDesc": "sample string 2",
      "DERCount": 1,
      "NumDERLocked": 1,
      "NumDERAvail": 1,
      "DEROldest": "sample string 3"
    },
    {
      "queueName": "sample string 1",
      "queueDesc": "sample string 2",
      "DERCount": 1,
      "NumDERLocked": 1,
      "NumDERAvail": 1,
      "DEROldest": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<GetDERQueueSummaryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <QueueSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/RapidAPI">
    <d2p1:pGetDERQueueSummaryResult>
      <d2p1:DERCount>1</d2p1:DERCount>
      <d2p1:DEROldest>sample string 3</d2p1:DEROldest>
      <d2p1:NumDERAvail>1</d2p1:NumDERAvail>
      <d2p1:NumDERLocked>1</d2p1:NumDERLocked>
      <d2p1:queueDesc>sample string 2</d2p1:queueDesc>
      <d2p1:queueName>sample string 1</d2p1:queueName>
    </d2p1:pGetDERQueueSummaryResult>
    <d2p1:pGetDERQueueSummaryResult>
      <d2p1:DERCount>1</d2p1:DERCount>
      <d2p1:DEROldest>sample string 3</d2p1:DEROldest>
      <d2p1:NumDERAvail>1</d2p1:NumDERAvail>
      <d2p1:NumDERLocked>1</d2p1:NumDERLocked>
      <d2p1:queueDesc>sample string 2</d2p1:queueDesc>
      <d2p1:queueName>sample string 1</d2p1:queueName>
    </d2p1:pGetDERQueueSummaryResult>
  </QueueSummary>
  <Success>true</Success>
</GetDERQueueSummaryResult>