GET GET_MGMT_DISPATCHERS

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

GetDispatchersResponse

GetMgmtDispatcherResponse

Name	Description	Type	Additional information
Header		ResponseHeader	None.
Body		GetMgmtDispatcherResponseBody	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

GetMgmtDispatcherResponseBody

Name	Description	Type	Additional information
ManagementDispatchers	List of Management Dispatchers.	Collection of DispatcherManagementViewModel	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": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "ManagementDispatchers": [
      {
        "DispEntity": 1,
        "DispatchID": "86742D",
        "Name": "Locks R Us",
        "Location": "US",
        "PhoneNo": "859-885-9911"
      },
      {
        "DispEntity": 2,
        "DispatchID": "86742E",
        "Name": "Central Dispatch",
        "Location": "US",
        "PhoneNo": "859-885-9213"
      },
      {
        "DispEntity": 3,
        "DispatchID": "112334",
        "Name": "SSS Sargent Greenleaf",
        "Location": "US",
        "PhoneNo": "859-885-9416"
      }
    ],
    "TotalCount": 3,
    "PageSize": 15,
    "Page": 1,
    "PageCount": 1
  }
}

application/xml, text/xml

Sample:

<GetMgmtDispatcherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>1</Page>
    <PageCount>1</PageCount>
    <PageSize>15</PageSize>
    <TotalCount>3</TotalCount>
    <d2p1:ManagementDispatchers xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:DispatcherManagementViewModel>
        <d3p1:DispEntity>1</d3p1:DispEntity>
        <d3p1:DispatchID>86742D</d3p1:DispatchID>
        <d3p1:Location>US</d3p1:Location>
        <d3p1:Name>Locks R Us</d3p1:Name>
        <d3p1:PhoneNo>859-885-9911</d3p1:PhoneNo>
      </d3p1:DispatcherManagementViewModel>
      <d3p1:DispatcherManagementViewModel>
        <d3p1:DispEntity>2</d3p1:DispEntity>
        <d3p1:DispatchID>86742E</d3p1:DispatchID>
        <d3p1:Location>US</d3p1:Location>
        <d3p1:Name>Central Dispatch</d3p1:Name>
        <d3p1:PhoneNo>859-885-9213</d3p1:PhoneNo>
      </d3p1:DispatcherManagementViewModel>
      <d3p1:DispatcherManagementViewModel>
        <d3p1:DispEntity>3</d3p1:DispEntity>
        <d3p1:DispatchID>112334</d3p1:DispatchID>
        <d3p1:Location>US</d3p1:Location>
        <d3p1:Name>SSS Sargent Greenleaf</d3p1:Name>
        <d3p1:PhoneNo>859-885-9416</d3p1:PhoneNo>
      </d3p1:DispatcherManagementViewModel>
    </d2p1:ManagementDispatchers>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</GetMgmtDispatcherResponse>