Viviot.Api

<back to all web services

GetQRCode

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin, Receptionist
The following routes are available for this service:
GET/reservation/userreservation/getqrcodeGets a QR code for a user reservation in Base64 format (done by a business user).
GetQRCode Parameters:
NameParameterData TypeRequiredDescription
UserReservationIdquerystringYesUser reservation Id (GUID)
ThingIdquerystringNoThing Id (GUID)
KeyLockCodeTypeEnumqueryKeyLockCodeTypeEnumNoKey code type (access, command)

Allowable Values

  • NotSet
  • AccessCode
  • ProgramAccessCode
  • ThirdPartyLockId
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
KeyLockCodeType Enum:
NameValue
NotSet0
AccessCode1
ProgramAccessCode2
ThirdPartyLockId3
GetQRCodeResponse Parameters:
NameParameterData TypeRequiredDescription
DataformDictionary<string, string>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /reservation/userreservation/getqrcode HTTP/1.1 
Host: api.4spaces.io 
Accept: application/json

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

{"data":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}