Viviot.Api

<back to all web services

GetQRCodeUsingAuthCode

The following routes are available for this service:
GET/reservation/userreservation/getqrcode-byauthcodeGets a QR code for a user reservation in Base64 format.
GetQRCodeUsingAuthCode Parameters:
NameParameterData TypeRequiredDescription
UserReservationIdquerystringYesUser reservation Id (GUID)
ThingIdquerystringNoThing Id (GUID)
AuthorizationCodequerystringYesCode to authorize access to data.
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 .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 /reservation/userreservation/getqrcode-byauthcode 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 'GetQRCodeResponse' 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'.)