Viviot.Api

<back to all web services

GetAllKeyCodes

Requires Authentication
The following routes are available for this service:
GET/mobileb/keycodes/allGets a list of all key codes for all smartspaces that a mobile businiess user has access to.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
AllKeyCodesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ThingKeyCodeView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ThingKeyCodeView Parameters:
NameParameterData TypeRequiredDescription
ThingIdformGuidNo
ThingNameformstringNo
SmartspaceIdformGuid?No
SmartspaceNameformstringNo
KeyLockTypeformKeyLockType?No
AccessKeyCodeformstringNo
AccessLevelformstringNo
KeyLockType Enum:
NameValue
Unsupported0
QRCode1
RFID2
KeyPad3
NFC4
Bluetooth5
VirtualCard6
AccessCard7

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /mobileb/keycodes/all HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'AllKeyCodesResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)