This API is used to retrieve access codes associated with the specified event. This API can be accessed by an event admin and super admin. It will return data like id, code, eventTicketTypeId, startDate, accessCodeList and many more. To call this API, user will have to pass query param with API URL like recurringEventId and authentication key to authenticate user.
Here is the description of response attributes, which returns to the form of JSON.
It will return a success message if API execute successfully.
Attribute | Description |
|---|---|
id | This contains a unique identify access code. |
code | This contains the access code, e.g. CODE10. 255 characters are allowed in Access code. |
eventTicketTypeId | This contains the ticket type for an event ticket. |
startDate | This contains the start date in dd/MM/yyyy HH:mm:ss format. |
endDate | This contains the end date in dd/MM/yyyy HH:mm:ss format. |
recurringRelativeStartTime | Access code starts from XX minutes before recurring event starts. |
recurringRelativeEndTime | Access code ends from XX minutes before recurring event ends |
accessCodeList | This will return the list of access codes. |
uses | This is the number of uses of access_code for unlimited ticket need to pass -1. Uses should be greater than zero. |
Here is the possible error messages, which return if any condition fails or required data is missing for processing.
Error Code | Error Description |
|---|---|
200 | Ok |
400 | The request could not be understood by the server due to malformed syntax. |
401 | You are not authorized to view the resource. |
403 | Accessing the resource you were trying to reach is forbidden. |
404 | The resource you were trying to reach is not found. |
4030201 | Not Event Host. |