GET GET_DISPATCHER/{dispatcherEntity}

Request Information

URI Parameters

Name	Description	Type	Additional information
dispatcherEntity		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetDispatherResponse

GetDispatcherResponse

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

GetDispatcherResponseBody

Name	Description	Type	Additional information
Dispatcher	Dispatcher	DispatchersViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "Dispatcher": {
      "DispEntity": 1,
      "Name": "sample string 2",
      "DispatchID": "sample string 3",
      "Location": "sample string 4",
      "PhoneNo": "sample string 5",
      "OwnerID": "sample string 6",
      "SystemOwner": true,
      "DispatcherBlock": "sample string 8",
      "ExportStartDate": "sample string 9",
      "ExportEndDate": "sample string 10",
      "IsResetUserTouchKey": true,
      "IsResetTamper": true,
      "IsDownloadAudit": true,
      "IsOpenLock": true,
      "privileges": {
        "DownloadAudit": true,
        "ResetUser": true,
        "ResetTamper": true,
        "AccessLock": true
      }
    }
  }
}

application/xml, text/xml

Sample:

<GetDispatcherResponse 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">
    <d2p1:Dispatcher xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:DispEntity>1</d3p1:DispEntity>
      <d3p1:DispatchID>sample string 3</d3p1:DispatchID>
      <d3p1:DispatcherBlock>sample string 8</d3p1:DispatcherBlock>
      <d3p1:ExportEndDate>sample string 10</d3p1:ExportEndDate>
      <d3p1:ExportStartDate>sample string 9</d3p1:ExportStartDate>
      <d3p1:IsDownloadAudit>true</d3p1:IsDownloadAudit>
      <d3p1:IsOpenLock>true</d3p1:IsOpenLock>
      <d3p1:IsResetTamper>true</d3p1:IsResetTamper>
      <d3p1:IsResetUserTouchKey>true</d3p1:IsResetUserTouchKey>
      <d3p1:Location>sample string 4</d3p1:Location>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:OwnerID>sample string 6</d3p1:OwnerID>
      <d3p1:PhoneNo>sample string 5</d3p1:PhoneNo>
      <d3p1:SystemOwner>true</d3p1:SystemOwner>
      <d3p1:privileges>
        <d3p1:AccessLock>true</d3p1:AccessLock>
        <d3p1:DownloadAudit>true</d3p1:DownloadAudit>
        <d3p1:ResetTamper>true</d3p1:ResetTamper>
        <d3p1:ResetUser>true</d3p1:ResetUser>
      </d3p1:privileges>
    </d2p1:Dispatcher>
  </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>
</GetDispatcherResponse>