GET GET_DISPATCHER_ATMS/{dispatcherEntity}

Request Information

URI Parameters

Name	Description	Type	Additional information
dispatcherEntity		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetDispatherAtmsResponse

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

GetDispatherAtmsResponseBody

Name	Description	Type	Additional information
DispatcherAtms	Get dispatcher atms List.	Collection of DispatcherAtmsQueryViewModel	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": {
    "DispatcherAtms": [
      {
        "AtmEntity": 1,
        "ATMIDPrimary": "ATM001",
        "ATMIDSecondary": "ATM001",
        "SiteName": "",
        "ToRemove": false
      },
      {
        "AtmEntity": 2,
        "ATMIDPrimary": "ATM",
        "ATMIDSecondary": "",
        "SiteName": "ATM",
        "ToRemove": true
      },
      {
        "AtmEntity": 3,
        "ATMIDPrimary": "ATM005",
        "ATMIDSecondary": "ATM005",
        "SiteName": "",
        "ToRemove": true
      }
    ],
    "TotalCount": 17,
    "PageSize": 5,
    "Page": 1,
    "PageCount": 3
  }
}

application/xml, text/xml

Sample:

<GetDispatherAtmsResponse 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>3</PageCount>
    <PageSize>5</PageSize>
    <TotalCount>17</TotalCount>
    <d2p1:DispatcherAtms xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:DispatcherAtmsQueryViewModel>
        <d3p1:ATMIDPrimary>ATM001</d3p1:ATMIDPrimary>
        <d3p1:ATMIDSecondary>ATM001</d3p1:ATMIDSecondary>
        <d3p1:AtmEntity>1</d3p1:AtmEntity>
        <d3p1:SiteName></d3p1:SiteName>
        <d3p1:ToRemove>false</d3p1:ToRemove>
      </d3p1:DispatcherAtmsQueryViewModel>
      <d3p1:DispatcherAtmsQueryViewModel>
        <d3p1:ATMIDPrimary>ATM</d3p1:ATMIDPrimary>
        <d3p1:ATMIDSecondary></d3p1:ATMIDSecondary>
        <d3p1:AtmEntity>2</d3p1:AtmEntity>
        <d3p1:SiteName>ATM</d3p1:SiteName>
        <d3p1:ToRemove>true</d3p1:ToRemove>
      </d3p1:DispatcherAtmsQueryViewModel>
      <d3p1:DispatcherAtmsQueryViewModel>
        <d3p1:ATMIDPrimary>ATM005</d3p1:ATMIDPrimary>
        <d3p1:ATMIDSecondary>ATM005</d3p1:ATMIDSecondary>
        <d3p1:AtmEntity>3</d3p1:AtmEntity>
        <d3p1:SiteName></d3p1:SiteName>
        <d3p1:ToRemove>true</d3p1:ToRemove>
      </d3p1:DispatcherAtmsQueryViewModel>
    </d2p1:DispatcherAtms>
  </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>
</GetDispatherAtmsResponse>