GET GET_COMMANDS

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

GetCommandsResponse

Name	Description	Type	Additional information
Header		ResponseHeader	None.
Body		GetCommandsResponseBody	None.

Response Header Description

ResponseHeader

Name	Description	Type	Additional information
Message	Message	string	None.
StatusCode	Status code	ResponseStatus	None.
Status	Status	string	None.
ErrorId	Error id	string	None.

Response Body Description

GetCommandsResponseBody

Name	Description	Type	Additional information
Commands	Get commands	Collection of CommandViewModel	None.
TotalCount	Total records count.	integer	None.
PageSize	Page size.	integer	None.
Page	Page	integer	None.
PageCount	Number of pages.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "Commands": [
      {
        "CmdID": 1,
        "Description": "sample string 2"
      },
      {
        "CmdID": 1,
        "Description": "sample string 2"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample:

<GetCommandsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Command">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Command" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:Commands xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:CommandViewModel>
        <d3p1:CmdID>1</d3p1:CmdID>
        <d3p1:Description>sample string 2</d3p1:Description>
      </d3p1:CommandViewModel>
      <d3p1:CommandViewModel>
        <d3p1:CmdID>1</d3p1:CmdID>
        <d3p1:Description>sample string 2</d3p1:Description>
      </d3p1:CommandViewModel>
    </d2p1:Commands>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</GetCommandsResponse>