GetKey
Will list parameters on a specified access key.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
| String | N/A | Unique identifier. |
Columns
Name | Data type | Unit of measurement | Nullability | Note |
---|---|---|---|---|
| String | N/A | FALSE | Unique identifier. |
| String | N/A | FALSE | Name of key |
| String | Hex Key ID | FALSE | |
| String | time string | FALSE | |
| String | time string | FALSE | |
| Bool | N/A | FALSE | |
| String | N/a | TRUE | |
| String | N/A | TRUE | |
| String | N/A | TRUE | |
| String | N/A | TRUE | |
| String | N/A | TRUE | |
| DateTime | UTC | TRUE | |
| String | N/A | TRUE | |
| String[] | N/A | TRUE | |
| String[] | N/A | TRUE |
Request (example)
{
"id": "11456"
}
Response
{
"list": [
{
"id": "11456",
"name": "Tom Persson",
"serialNumber": "6200011587691E09",
"keyValid": "60sec",
"keyExpire": "10min",
"isAdmin": false,
"companyName": "Chemnitz Bau- & Materiel",
"note": "",
"expirationDate": "2014-06-30T22:00:00.0000000",
"employeeNumber": "8",
"units": [],
"groups": [
"8820"
]
}
]
}
CreateKey
Will create a new key.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
| String | N/A | Name of key |
| String | Hex Key ID | |
| String | Time string | Select between the following string values: |
| String | Time string | Select between the following string values: |
| Bool | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| DateTime | UTC | |
| String | N/A | |
| String[] | N/A | |
| String[] | N/A |
Request (example)
{
"name": "Anton Malmlund",
"serialNumber": "6800801587691F09",
"keyValid": "60sec",
"keyExpire": "10min",
"companyName": "Chemnitz Bau- & Materiel",
"employeeNumber": "21",
"groups": [
"8818"
]
}
Response
{
"id": "11504"
}
UpdateKey
Will update parameters on an existing key.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
| String | N/A | Unique identifier |
| String | N/A | Name of key. |
| String | Hex Key ID | |
| String | Time string | Select between the following string values: |
| String | Time string | Select between the following string values: |
| Bool | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| String | N/A | |
| DateTime | UTC | |
| String | N/A | |
| String[] | N/A | |
| String[] | N/A | |
| String[] | N/A | |
| String[] | N/A |
Request (example)
{
"id": "11455",
"name": "John Ericsson",
"serialNumber": "6100001587691E09",
"addGroups": [
"8818"
]
}
Response
{}
DeleteKey
Will delete an existing key.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
| String | N/A | Unique identifier. |
Request (example)
{
"id": "11455"
}
Response
{}
Updated less than a minute ago