Existing App Scans

Event when a Wallet pass has been scanned

An App Scan is a record to track and analyse that a Wallet pass has been scanned at your venue or your store. In Passcreator an App Scan is always tied to an App Configuration that defines what happens after the Scan.

Get list of App Scans

URL

https://app.passcreator.com/api/appscan?appConfigurationId={configurationId}

optional: https://app.passcreator.com/api/appscan?appConfigurationId={configurationId}&createdSince=dateTime (e.g. 2017-05-01 20:55:00)

HTTP-Method
GET
Purpose
Returns a list of all App Scans that are associated with the given App Configuration
Required input parameters

• HTTP Authorization Header that contains your API key

• appConfigurationId - the UUID of the App Configuration you want to get App Scans for. You can find the UUID of the Configuration by listing your existing App Configurations.

• createdSince (optional) - a date and time since when you want to get App Scans

Returned values

• scanStatus - 0 means the pass was known and has been voided after it has been scanned. 1 means the pass was know but it has already been voided and is therefore not valid. 2 means the pass was known and the attendance of a user has been saved. 3 means the pass hasn't been found which happens if an invalid Barcode is scanned. This can happen e.g. if you've deleted passes or a Barcode value that is invalid in general has been scanned.

• createdOn - the date and time when the App Scan has been saved

• passId - the UUID of the pass that has been scanned. Can be null if the scanned value of the App Scan is not known. The UUID is an identifier for Passcreator and you only need it if you want to use the API to e.g. receive information about that pass.

• passGeneratedId - the unique ID that is created by Passcreator for each pass that can be shown as barcode value

• passSearchString - a string representation of the content of the pass. Fields are separated by pipes (|)

• passVoided - true or false - indicates if the pass is voided or not, which means if it is still valid or not. True means the pass is not valid anymore, false means it is still valid.

• passUserProvidedId - the ID that can be provided if you're creating a pass using the API.

• passTemplateGuid - the UUID of the Pass Template that has been used to create the pass

• passTemplateName - the name of the Pass Template

• appConfigurationId - the UUID of the App Configuration of the App Scan

• scannedBarcodeValue - the value of the Barcode that has been scanned

• appScanId - the unique identifier (UUID) of this very App Scan

Example output:

  1. [
  2. {
  3. "scanStatus": 1,
  4. "createdOn": "2017-04-25 20:55:39",
  5. "passId": "198b5f2f-ae59-4b1f-8d43-7726dc9a738c",
  6. "passGeneratedId": "58ff47678758f4.39729240",
  7. "passSearchString": "|58ff47678758f4.39729240|no value set|no value set|{Name}|für die Beachparty|15.06.2012|Bundesanstalt Technisches Hilfswerk \r\nOrtsverband München-Ost\r\nUnterbiberger Str. 5\r\n81737 München|",
  8. "passVoided": true,
  9. "passUserProvidedId": "",
  10. "passTemplateGuid": "99c514a8-35c8-47a5-be30-51e233c21963",
  11. "passTemplateName": "test",
  12. "appConfigurationId": "d348b157-e15b-445b-a1e3-0d26101f3b20",
  13. "scannedBarcodeValue": "58ff47678758f4.39729240",
  14. "appScanId": "d3089102-0e4c-4642-86ef-e536a0b3c282"
  15. },
  16. {
  17. "scanStatus": 1,
  18. "createdOn": "2017-04-25 20:55:05",
  19. "passId": "198b5f2f-ae59-4b1f-8d43-7726dc9a738c",
  20. "passGeneratedId": "58ff47678758f4.39729240",
  21. "passSearchString": "|58ff47678758f4.39729240|no value set|no value set|{Name}|für die Beachparty|15.06.2012|Bundesanstalt Technisches Hilfswerk \r\nOrtsverband München-Ost\r\nUnterbiberger Str. 5\r\n81737 München|",
  22. "passVoided": true,
  23. "passUserProvidedId": "",
  24. "passTemplateGuid": "99c514a8-35c8-47a5-be30-51e233c21963",
  25. "passTemplateName": "test",
  26. "appConfigurationId": "d348b157-e15b-445b-a1e3-0d26101f3b20",
  27. "scannedBarcodeValue": "58ff47678758f4.39729240",
  28. "appScanId": "248d16a9-6b24-450b-b6b0-a1050d2810ce"
  29. }
  30. ]