Request Information

URI Parameters

None.

Body Parameters

VerifyConnectionRequest
NameDescriptionTypeAdditional information
Host

Host

string

Required

Port

Port

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Host": "www.example.com",
  "Port": "8888"
}

application/xml, text/xml

Sample:
<VerifyConnectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">
  <Host>www.example.com</Host>
  <Port>8888</Port>
</VerifyConnectionRequest>

application/x-www-form-urlencoded

Sample:
Host=www.example.com&Port=8888

Response Information

Resource Description

VerifyConnectionResponse

VerifyConnectionResponse
NameDescriptionTypeAdditional information
Header

Access token expired response message header.

ResponseHeader

None.

Body

Access token expired response message body.

VerifyConnectionResponseBody

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

VerifyConnectionResponseBody
NameDescriptionTypeAdditional information
IsAccessible

Determines if the token is expired.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "IsAccessible": true
  }
}

application/xml, text/xml

Sample:
<VerifyConnectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
  <Body>
    <IsAccessible>true</IsAccessible>
  </Body>
  <Header>
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</VerifyConnectionResponse>

© 2025 Sargent and Greenleaf