Request Information

URI Parameters

None.

Body Parameters

ReturnDispEntityRequest

ReturnDispEntityRequest
NameDescriptionTypeAdditional information
OwnerEntity

Entity value for the owner (database value)

integer

Required

AtmEntity

Entity value for the ATM (database value)

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "OwnerEntity": 1,
  "AtmEntity": 2
}

application/xml, text/xml

Sample:
<ReturnDispEntityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Dispatcher">
  <AtmEntity>2</AtmEntity>
  <OwnerEntity>1</OwnerEntity>
</ReturnDispEntityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnDispEntityResponse

ReturnDispEntityResponse
NameDescriptionTypeAdditional information
Header

Dispatcher Entity response message header.

ResponseHeader

None.

Body

Dispatcher Entity response message body.

ReturnDispEntityResponseBody

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

ReturnDispEntityResponseBody
NameDescriptionTypeAdditional information
DispatcherEntity

Entity value for the dispatcher (database value)

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "DispatcherEntity": 1
  }
}

application/xml, text/xml

Sample:
<ReturnDispEntityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher">
  <Body>
    <DispatcherEntity>1</DispatcherEntity>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId>sample string 3</d2p1:ErrorId>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Status>sample string 2</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</ReturnDispEntityResponse>

© 2025 Sargent and Greenleaf