Request Information

URI Parameters

NameDescriptionTypeAdditional information
dispatcherEntity

Entity value for the dispatcher (database value)

integer

Required

Body Parameters

None.

Response Information

Resource Description

DeleteDispatcherAtmsResponse

DeleteDispatcherAtmsResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

DeleteDispatcherAtmsResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

string

None.

StatusCode

Status code

ResponseStatus

None.

Status

Status

string

None.

ErrorId

Error id

string

None.

Response Body Description

DeleteDispatcherAtmsResponseBody
NameDescriptionTypeAdditional information
DispatcherAtmsDeleted

Flag to show if dispatcher atms successfully deleted

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "DispatcherAtmsDeleted": true
  }
}

application/xml, text/xml

Sample:
<DeleteDispatcherAtmsResponse 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:DispatcherAtmsDeleted>true</d2p1:DispatcherAtmsDeleted>
  </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>
</DeleteDispatcherAtmsResponse>

© 2025 Sargent and Greenleaf