This function will return the available management commands that have been setup for a specified dispatcher. INPUTS==> DISPATCHER ENTITY. RETURN==> list of management commands (for that dispatcher)
| Name | Description | Type | Additional information |
|---|---|---|---|
| dispEntity |
Dispatcher Entity. |
integer |
Required |
None.
GetManagerCommandsResponse
GetManagerCommandsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | GetManagerCommandsResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Commands |
Get manager 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. |
{
"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
}
}
<GetManagerCommandsResponse 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>
</GetManagerCommandsResponse>