Create App Configurations

Create a new App Configuration using the Passcreator API

Create a new app configuration

An app configuration is primarily used to tell the companion app what passes should be validated and what must happen after scanning them (e.g. mark the pass voided or only save that a user was there).

Also, every app scan is tied to an app configuration.

URL
https://app.passcreator.com/api/appconfiguration
HTTP-Method
POST
Purpose
Creates a new app configuration
Required input parameters

• HTTP Authorization Header that contains your API key

• name - the name 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.

• 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 (optional) - 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. A valid additional property always consists of two parameters: the name of the property and the type. Currently supported types are unicode (text values), double (numeric values) and boolean.

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

• 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.

• a configuration link is automatically created that can be used to configure the app. This link won't expire (like the links you create using the online application) and the users can't change the configuration if they use that link.

Example JSON payload:

  1. {
  2. "name": "Example configuration",
  3. "passTemplateId": "",
  4. "scanMode": 1,
  5. "additionalProperties": [
  6. {
  7. "type": "boolean",
  8. "name": "Allowed to send marketing mails?"
  9. },
  10. {
  11. "type": "unicode",
  12. "name": "Tell us about you"
  13. },
  14. {
  15. "type": "double",
  16. "name": "Transaction value"
  17. }
  18. ]
  19. }

Example output:

  1. {
  2. "configuration": [
  3. {
  4. "name": "Test API",
  5. "configurationId": "be0937ca-3bac-40b9-b189-45ec70e0cbe5",
  6. "passTemplateId": null,
  7. "passTemplateName": null,
  8. "createdOn": "2018-03-14 07:36:03",
  9. "scanMode": 1,
  10. "place": "",
  11. "additionalProperties": [
  12. {
  13. "type": "boolean",
  14. "name": "Allowed to send marketing mails?",
  15. "id": 0
  16. },
  17. {
  18. "type": "unicode",
  19. "name": "Tell us about you",
  20. "id": 1
  21. },
  22. {
  23. "type": "double",
  24. "name": "Transaction value",
  25. "id": 2
  26. }
  27. ]
  28. }
  29. ],
  30. "configurationLink": "https://passcreator.test-app.link/iGzYnchzlbrmpftFXgL"
  31. }