A Series One Time Code (OTC)
  1. Help
  2. GET SystemInfo

GET SystemInfo

Return the system information for the API setup.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SystemInfoResponse

SystemInfoResponse
NameDescriptionTypeAdditional information
Header

System information response message header.

 ResponseHeader

None.
Body

System information response message body.

 SystemInfoResponseBody

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

SystemInfoResponseBody
NameDescriptionTypeAdditional information
SystemVersion

System version

 string

None.
ProductName

Product name

 string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<SystemInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
  <Body>
    <ProductName>sample string 2</ProductName>
    <SystemVersion>sample string 1</SystemVersion>
  </Body>
  <Header>
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</SystemInfoResponse>
© 2025 Sargent and Greenleaf