Appearance
findEventByQRAccessCode ​
Returns an Event given a valid Event QR Access Code
Request ​
http
GET /rest/user/mi/events/qraccesscodeHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
QUERY PARAMS:
| Parameter | Type | Required | Description |
|---|---|---|---|
accessCode | - | Yes | Valid QR Access Code for an Event (typed in by a user) e.g. EVENT2017. NOTE: these are globally unique and case insensitive |
version | - | No | Version for this API. If not passed defaults to legacy version 1. When version=1 then the returned eventUUID field is overridden to contain the QRCodeUUID to be compatible with the (incorrect) version 1 usage of this field. If version=2 passed then the API returns the correct and expected values for both eventUUID and eventQRCodeUUID. NOTE: eventUUID is a unique id for the Event, whereas eventQRCodeUUID purely relates to an Event QR Code. Added 29th Nov 2017 (TP#11490). |
Response ​
200 OK ​
Returns and a single EventJSON object as per below example:
json
{
"eId": 112,
"cId": 3,
"cName": "My Interact Finance",
"eStatus": "A",
"eName": "Test QR Code",
"eDescription": "cvfvfvxcvcxvcx",
"eAddress": "Aaron's Place",
"eStreet": "67 Market Street",
"eSuburb": "Randwick",
"eCity": "Randwick",
"ePostCode": "2031",
"eCountry": "AUSTRALIA",
"eImage": "http://dev-sam-images.interact.technology/3/images/mercedes.jpg",
"eLatitude": -33.9069644,
"eLongitude": 151.2456537,
"eTimezoneId": "Australia/Sydney",
"eGmtOffsetMinutes": 600,
"eLocalStartDateTime": 1467777300000,
"eLocalEndDateTime": 1467950100000,
"eventUUID": "2b557dff-df52-4526-821b-0e881207ca81",
"eventQRCodeUUID": "6b7456a7-bbbe-4233-bafb-19fcb60feaa2",
"eHasEnded": "N",
"eAttendeeId": 16,
"eAttendeeInviteStatus": "P",
"eAttendeeAttendingStatus": "U",
"eAttendeeInvitesSent": 0,
"eAttendeeRemindersSent": 0
"useExternalEventProvider": "N",
"version": 2
}Errors ​
| Exception | Description |
|---|---|
WSEventServiceUnavailableException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSQRCodeNotFoundException | See Error Definitions |
WSEventCancelledException | See Error Definitions |
WSEventServiceException | See Error Definitions |
WSCacheServiceException | See Error Definitions |