Request Information

URI Parameters

None.

Body Parameters

RegisterDeviceRequest
NameDescriptionTypeAdditional information
DeviceId

string

None.

Description

string

None.

MACAddress

string

None.

DateRegistered

date

None.

Request Formats

application/json, text/json

Sample:
{
  "DeviceId": "sample string 1",
  "Description": "sample string 2",
  "MACAddress": "sample string 3",
  "DateRegistered": "2025-12-18T04:55:41.9188255-08:00"
}

application/xml, text/xml

Sample:
<RegisterDeviceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">
  <DateRegistered>2025-12-18T04:55:41.9188255-08:00</DateRegistered>
  <Description>sample string 2</Description>
  <DeviceId>sample string 1</DeviceId>
  <MACAddress>sample string 3</MACAddress>
</RegisterDeviceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegisterDeviceResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

RegisterDeviceResponseBody

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

RegisterDeviceResponseBody
NameDescriptionTypeAdditional information
DeviceRegistered

boolean

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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

© 2025 Sargent and Greenleaf