Request Information

URI Parameters

None.

Body Parameters

ArchiveInitOperationCodeRequest

ArchiveInitOperationCodeRequest
NameDescriptionTypeAdditional information
LockID

Lock ID

string

Required

EmployeeID

Employee ID

string

Required

TouchKey

Touch Key

string

Required

UserName

User Name

string

Required

OperatorName

Operator Name

string

Required

LocationID

Location ID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "LockID": "sample string 1",
  "EmployeeID": "sample string 2",
  "TouchKey": "sample string 3",
  "UserName": "sample string 4",
  "OperatorName": "sample string 5",
  "LocationID": "sample string 6"
}

application/xml, text/xml

Sample:
<ArchiveInitOperationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.OperationCodesQuery">
  <EmployeeID>sample string 2</EmployeeID>
  <LocationID>sample string 6</LocationID>
  <LockID>sample string 1</LockID>
  <OperatorName>sample string 5</OperatorName>
  <TouchKey>sample string 3</TouchKey>
  <UserName>sample string 4</UserName>
</ArchiveInitOperationCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArchiveInitOperationCodeResponse

ArchiveInitOperationCodeResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

ArchiveInitOperationCodeResponseBody

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

ArchiveInitOperationCodeResponseBody
NameDescriptionTypeAdditional information
InitOpCodeArchived

Flag to show if lock initialization code was successfully closed

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": {
    "InitOpCodeArchived": true
  }
}

application/xml, text/xml

Sample:
<ArchiveInitOperationCodeResponse 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:InitOpCodeArchived>true</d2p1:InitOpCodeArchived>
  </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>
</ArchiveInitOperationCodeResponse>

© 2025 Sargent and Greenleaf