List App Scans

This endpoint returns a list of all App Scans that are associated with the given App Configuration.

This endpoint is deprecated. Use the new list endpoint that supports pagination instead.

GET/api/appscan?appConfigurationId={configurationId}

List App Scans

Returns a list of all App Scans that are associated with the given App Configuration.

Query Parameters

Name
appConfigurationId
Type
string
(mandatory)
Description
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.
Name
createdSince
Type
string
(optional)
Description
A date and time since when you want to get App Scans (e.g. 2017-05-01 20:55:00).

Example URLs

Request URL without filter

https://app.passcreator.com/api/appscan?appConfigurationId=d348b157-e15b-445b-a1e3-0d26101f3b20

Request URL with filter

https://app.passcreator.com/api/appscan?appConfigurationId=d348b157-e15b-445b-a1e3-0d26101f3b20&createdSince=2017-05-01 20:55:00

Authorization

Name
Authorization
Type
string
(mandatory)
Description
HTTP Header containing your API key. Replace yourApiKeyHere with your actual API key.

Example HTTP Header

HTTP header

GET /api/appscan?appConfigurationId={configurationId} HTTP/1.1
Host: app.passcreator.com
Authorization: yourApiKeyHere

Returned Values

Name
scanStatus
Type
integer
(mandatory)
Description
- 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.
Name
createdOn
Type
string
(mandatory)
Description
The date and time when the App Scan has been saved.
Name
passId
Type
string | null
(mandatory)
Description
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.
Name
passGeneratedId
Type
string
(mandatory)
Description
The unique ID that is created by Passcreator for each pass that can be shown as barcode value.
Name
passSearchString
Type
string
(mandatory)
Description
A string representation of the content of the pass. Fields are separated by pipes (|).
Name
passVoided
Type
boolean
(mandatory)
Description
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.
Name
passUserProvidedId
Type
string
(mandatory)
Description
The ID that can be provided if you're creating a pass using the API.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The UUID of the Pass Template that has been used to create the pass.
Name
passTemplateName
Type
string
(mandatory)
Description
The name of the Pass Template.
Name
appConfigurationId
Type
string
(mandatory)
Description
The UUID of the App Configuration of the App Scan.
Name
scannedBarcodeValue
Type
string
(mandatory)
Description
The value of the Barcode that has been scanned.
Name
appScanId
Type
string
(mandatory)
Description
The unique identifier (UUID) of this very App Scan.

Example Response

Response

[
  {
    "scanStatus": 1,
    "createdOn": "2017-04-25 20:55:39",
    "passId": "198b5f2f-ae59-4b1f-8d43-7726dc9a738c",
    "passGeneratedId": "58ff47678758f4.39729240",
    "passSearchString": "|58ff47678758f4.39729240|no value set|no value set|{Name}|für die Be",
    "passVoided": true,
    "passUserProvidedId": "",
    "passTemplateGuid": "99c514a8-35c8-47a5-be30-51e233c21963",
    "passTemplateName": "test",
    "appConfigurationId": "d348b157-e15b-445b-a1e3-0d26101f3b20",
    "scannedBarcodeValue": "58ff47678758f4.39729240",
    "appScanId": "d3089102-0e4c-4642-86ef-e536a0b3c282"
  },
  {
    "scanStatus": 1,
    "createdOn": "2017-04-25 20:55:05",
    "passId": "198b5f2f-ae59-4b1f-8d43-7726dc9a738c",
    "passGeneratedId": "58ff47678758f4.39729240",
    "passSearchString": "|58ff47678758f4.39729240|no value set|no value set|{Name}|für die Be",
    "passVoided": true,
    "passUserProvidedId": "",
    "passTemplateGuid": "99c514a8-35c8-47a5-be30-51e233c21963",
    "passTemplateName": "test",
    "appConfigurationId": "d348b157-e15b-445b-a1e3-0d26101f3b20",
    "scannedBarcodeValue": "58ff47678758f4.39729240",
    "appScanId": "248d16a9-6b24-450b-b6b0-a1050d2810ce"
  }
]

Code Examples

Here you can find examples of how to call this endpoint using different programming languages and tools.

Replace d348b157-e15b-445b-a1e3-0d26101f3b20 with your actual App Configuration ID and yourApiKeyHere with your actual API key.

Request Examples

GET

/api/appscan?appConfigurationId={configurationId}

curl -X GET "https://app.passcreator.com/api/appscan?appConfigurationId=d348b157-e15b-445b-a1e3-0d26101f3b20" \
  -H "Authorization: yourApiKeyHere"