Existing app configurations

Managing App Configurations to track Scans of your Wallet passes

Get a list of all App Configurations

You can use Passcreator to keep track of and analyze the Scans of passes that usually happen at the POS system (if you're using Coupons) or at the entrance of an event (if you're using tickets).

The concept in general is that you define an App Configuration in the Passcreator online application that defines what pass template should be validated and what should happen after a pass has been scanned. Currently there are two modes: a pass will be voided after it has been scanned or the system just saves the attendance of a user and doesn't invalidate the pass.

Using an App Configuration you can create App Scans. An App Scan is always tied to an App Configuration and represents a single event (=the Scan happened). You can save App Scans no matter if they have been valid. Passcreator is also able to store Scans of unknown pass IDs.

This concept is also used inside the Passcreator Companion App to validate passes. You should first read a list of App Configurations that have been created in the Passcreator online application. After you know what App Configuration should be used (because the user or you've selected it) you can submit App Scans to the Passcreator system.

URL
https://app.passcreator.com/api/appconfiguration
HTTP-Method
GET
Purpose
Returns a list of all App Configurations that have been created for the current account
Required input parameters
• HTTP Authorization Header that contains your API key
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.

Example output:

  1. [
  2. {
  3. "name": "Example configuration",
  4. "configurationId": "d0a467cf-391a-4b89-a00e-dc57a56d7b7b",
  5. "passTemplateId": null,
  6. "passTemplateName": null,
  7. "createdOn": "2017-04-26 21:47:31",
  8. "scanMode": 0,
  9. "place": "",
  10. "additionalProperties": [
  11. {
  12. "type": "boolean",
  13. "name": "Allowed to send marketing mails?",
  14. "id": 0
  15. },
  16. {
  17. "type": "unicode",
  18. "name": "tell us about you",
  19. "id": 1
  20. }
  21. ]
  22. },
  23. {
  24. "name": "Second example configuration",
  25. "configurationId": "e5c9eee4-038b-41e1-acac-e0edb344c993",
  26. "passTemplateId": null,
  27. "passTemplateName": null,
  28. "createdOn": "2017-01-03 09:33:15",
  29. "scanMode": 1,
  30. "place": "Room 1"
  31. }
  32. ]

Get information about a single App Configuration

URL
https://app.passcreator.com/api/appconfiguration/{identifier}
HTTP-Method
GET
Purpose
Returns information about the App Configuration specified by its identifier
Required input parameters

• HTTP Authorization Header that contains your API key

• Identifier of the App Configuration

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.

Example output:

  1. [
  2. {
  3. "name": "Example configuration",
  4. "configurationId": "d0a467cf-391a-4b89-a00e-dc57a56d7b7b",
  5. "passTemplateId": null,
  6. "passTemplateName": null,
  7. "createdOn": "2017-04-26 21:47:31",
  8. "scanMode": 0,
  9. "place": "",
  10. "additionalProperties": [
  11. {
  12. "type": "boolean",
  13. "name": "Allowed to send marketing mails?",
  14. "id": 0
  15. },
  16. {
  17. "type": "unicode",
  18. "name": "Tell us about you",
  19. "id": 1
  20. }
  21. ]
  22. }
  23. ]