Request Information

URI Parameters

None.

Body Parameters

CloseCodeViaASealRequest

CloseCodeViaASealRequest
NameDescriptionTypeAdditional information
TechnicianId

Technician Id

integer

Required

ASeal

A Seal value

string

Required

Request Formats

application/json, text/json

Sample:
{
  "TechnicianId": 1,
  "ASeal": "1233"
}

application/xml, text/xml

Sample:
<CloseCodeViaASealRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests.GenerateOperationCodes">
  <ASeal>1233</ASeal>
  <TechnicianId>1</TechnicianId>
</CloseCodeViaASealRequest>

application/x-www-form-urlencoded

Sample:
TechnicianId=1&ASeal=1233

Response Information

Resource Description

CloseCodeResponse

CloseCodeResponse
NameDescriptionTypeAdditional information
Header

Close code response message header.

ResponseHeader

None.

Body

Close code response message body.

CloseCodeResponseBody

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

CloseCodeResponseBody
NameDescriptionTypeAdditional information
CodeClosed

Determines if the code was successfully closed.

boolean

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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

© 2025 Sargent and Greenleaf