This function will create a lock initialization record for the specified lock. INPUTS==> TOUCH KEY ID, USER TYPE, RECIPIENT ID, CREATOR ID, LOCK ENTITY, EMPLOYEE ID, LOCATION ID. RETURN==> (result)
None.
GenerateInitOperationCodeRequest
GenerateInitOperationCodeRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TouchKey |
Touch Key ID for the touch key to be used in the lock initialization |
string |
Required |
| UserType |
Type of touch key (M / U) |
string |
Required |
| RecipientId |
Recipient ID of the technician assigned to the lock initialization |
integer |
Required |
| CreatorId |
Creator ID of the operator who generated the lock initialization |
integer |
Required |
| LockEntity |
Entity value for the lock (database value) |
integer |
Required |
| EmployeeId |
Employee ID of the technician assigned to the lock initialization |
string |
Required |
| LocationId |
Location ID |
string |
None. |
{
"TouchKey": "sample string 1",
"UserType": "sample string 2",
"RecipientId": 3,
"CreatorId": 4,
"LockEntity": 5,
"EmployeeId": "sample string 6",
"LocationId": "sample string 7"
}
<GenerateInitOperationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.OperationCodesQuery"> <CreatorId>4</CreatorId> <EmployeeId>sample string 6</EmployeeId> <LocationId>sample string 7</LocationId> <LockEntity>5</LockEntity> <RecipientId>3</RecipientId> <TouchKey>sample string 1</TouchKey> <UserType>sample string 2</UserType> </GenerateInitOperationCodeRequest>
Sample not available.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | GenerateInitOperationCodeResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| InitOpCodeGenerated |
Flag to show if initialization was successfully generated |
boolean |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"InitOpCodeGenerated": true
}
}
<GenerateInitOperationCodeResponse 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:InitOpCodeGenerated>true</d2p1:InitOpCodeGenerated>
</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>
</GenerateInitOperationCodeResponse>