Developer Documentation (API)
List App Configurations
GET Request
Endpoint URL https://veski.leikbreytir.is/api/appconfiguration
Purpose
Returns a list of all App Configurations that have been created for the current account.
Returned values
- name – the name of the App Configuration
- configurationId – the unique ID of the App Configuration
- passTemplateId – the unique ID of the Pass Template whose passes should be validated. If the ID is null, all passes will be validated, no matter which Pass Template has been used to create them.
- passTemplateName – the name of the Pass Template. Can be null if all passes should be validated
- createdOn – the date and time the configuration has been created
- createdOnUtc – the date and time the configuration has been created in UTC
- scanMode – 0 means the pass will be voided after it has been scanned. 1 means the Scan will only note that the pass has been scanned without voiding it
- place – the place that has been specified in the App Configuration. Can be e.g. a room at your venue.
- additionalProperties – an array of additonal properties that should be asked for if a pass is scanned. The ID and the value the user has specified should be submitted when creating App Scans.
Example output:
[
{
"name": "Example configuration",
"configurationId": "d0a467cf-391a-4b89-a00e-dc57a56d7b7b",
"passTemplateId": null,
"passTemplateName": null,
"createdOn": "2017-04-26 21:47:31",
"createdOnUtc": "2017-04-26 19:47:31",
"scanMode": 0,
"place": "",
"additionalProperties": [
{
"type": "boolean",
"name": "Allowed to send marketing mails?",
"id": 0
},
{
"type": "unicode",
"name": "tell us about you",
"id": 1
}
]
},
{
"name": "Second example configuration",
"configurationId": "e5c9eee4-038b-41e1-acac-e0edb344c993",
"passTemplateId": null,
"passTemplateName": null,
"createdOn": "2017-01-03 09:33:15",
"scanMode": 1,
"place": "Room 1"
}
]