Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Boolean

SystemSettingsResponse
NameDescriptionTypeAdditional information
Header

System information response message header.

ResponseHeader

None.

Body

System information response message body.

SystemSettingsResponseBody

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

SystemSettingsResponseBody
NameDescriptionTypeAdditional information
Location

Location ID

string

None.

TimeZone

TimeZone

integer

None.

TimeOutValue

TimeOut Value

integer

None.

IsSoutherHemisphere

SouthernHemisphere Flag

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": {
    "Location": "sample string 1",
    "TimeZone": 2,
    "TimeOutValue": 3,
    "IsSoutherHemisphere": true
  }
}

application/xml, text/xml

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

© 2025 Sargent and Greenleaf