Request Information

URI Parameters

None.

Body Parameters

GetErrorMessageRequest
NameDescriptionTypeAdditional information
ErrorCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ErrorCode": "1001"
}

application/xml, text/xml

Sample:
<GetErrorMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">
  <ErrorCode>1001</ErrorCode>
</GetErrorMessageRequest>

application/x-www-form-urlencoded

Sample:
ErrorCode=1001

Response Information

Resource Description

GetErrorMessageResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

GetErrorMessageResponseBody

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

GetErrorMessageResponseBody
NameDescriptionTypeAdditional information
Id

integer

None.

ErrorCode

string

None.

Description

string

None.

Type

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "Id": 1,
    "ErrorCode": "1001",
    "Description": "Success",
    "Type": "iButton"
  }
}

application/xml, text/xml

Sample:
<GetErrorMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
  <Body>
    <Description>Success</Description>
    <ErrorCode>1001</ErrorCode>
    <Id>1</Id>
    <Type>iButton</Type>
  </Body>
  <Header>
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</GetErrorMessageResponse>

© 2025 Sargent and Greenleaf