This function will add a new touch key record to the database. INPUTS==> touch key information (TOUCH KEY ID, TYPE, LOCATION ID). RETURN==> (result)
None.
AddTouchKeyRequest
AddTouchKeyRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TouchKeyId |
Touch Key ID |
string |
Required Matching regular expression pattern: ^[A-Z0-9]+$ String length: inclusive between 0 and 20 |
| TypeKey |
Touch Key type |
string |
Required Matching regular expression pattern: ^[A-Z]+$ String length: inclusive between 4 and 4 |
| LocationId |
Location ID |
string |
None. |
{
"TouchKeyId": "sample string 1",
"TypeKey": "sample string 2",
"LocationId": "sample string 3"
}
<AddTouchKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.TouchKey"> <LocationId>sample string 3</LocationId> <TouchKeyId>sample string 1</TouchKeyId> <TypeKey>sample string 2</TypeKey> </AddTouchKeyRequest>
Sample not available.
AddTouchKeyResponse
AddTouchKeyResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | AddTouchKeyResponseBody |
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 |
|---|---|---|---|
| TouchKeySaved |
Flag to show if touch key successfully added |
boolean |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"TouchKeySaved": true
}
}
<AddTouchKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.TouchKey">
<Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.TouchKey" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:TouchKeySaved>true</d2p1:TouchKeySaved>
</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>
</AddTouchKeyResponse>