Request Information

URI Parameters

None.

Body Parameters

ArchiveOperationCodeRequest
NameDescriptionTypeAdditional information
LockId

LockId

string

Required

Request Formats

application/json, text/json

Sample:
{
  "LockId": "sample string 1"
}

application/xml, text/xml

Sample:
<ArchiveOperationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Lock">
  <LockId>sample string 1</LockId>
</ArchiveOperationCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArchiveCloseOperationCodesResponse

ArchiveCloseOperationCodesResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

ArchiveCloseOperationCodesResponseBody

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

ArchiveCloseOperationCodesResponseBody
NameDescriptionTypeAdditional information
CloseOpCodesArchived

Archive Closed Operation Code 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": {
    "CloseOpCodesArchived": true
  }
}

application/xml, text/xml

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

© 2025 Sargent and Greenleaf