Viviot.Api

GetAllKeyCodes

The following routes are available for this service:
GET	/mobileb/keycodes/all	Gets a list of all key codes for all smartspaces that a mobile businiess user has access to.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**AllKeyCodesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<ThingKeyCodeView>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ThingKeyCodeView** Parameters:
Name	Parameter	Data Type	Required
ThingId	form	Guid	No
ThingName	form	string	No
SmartspaceId	form	Guid?	No
SmartspaceName	form	string	No
KeyLockType	form	KeyLockType?	No
AccessKeyCode	form	string	No
AccessLevel	form	string	No

**KeyLockType** Enum:
Name	Value
Unsupported	0
QRCode	1
RFID	2
KeyPad	3
NFC	4
Bluetooth	5
VirtualCard	6
AccessCard	7

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AllKeyCodesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.Thing">
    <d2p1:ThingKeyCodeView>
      <d2p1:AccessKeyCode>String</d2p1:AccessKeyCode>
      <d2p1:AccessLevel>String</d2p1:AccessLevel>
      <d2p1:KeyLockType>Unsupported</d2p1:KeyLockType>
      <d2p1:SmartspaceId>00000000-0000-0000-0000-000000000000</d2p1:SmartspaceId>
      <d2p1:SmartspaceName>String</d2p1:SmartspaceName>
      <d2p1:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
      <d2p1:ThingName>String</d2p1:ThingName>
    </d2p1:ThingKeyCodeView>
  </Data>
</AllKeyCodesResponse>