Skip to content

Export Pass Templates

The Export Pass Templates API exports all or selected pass templates to a zip file of compressed JSON files. The selected pass templates are identified by the template ID which is returned by the Create Pass Template API. For information about the structure of the JSON files see JSON Files for Import and Export.

URL

To export selected pass templates, the HTTP URL is:

http://<host>:<port>/api/v1/templates/pass/export?templateIds=1,2,5

To export all pass templates, the HTTP URL is:

http://<host>:<port>/api/v1/templates/pass/export?exportAll=true

This API is secure and implements Gateway Filter for Authentication/Basic Authentication to authenticate access of the API by a user.

Method

GET

The payload's request header includes Content-Type as application/x-www-form-urlencoded.

Output Parameters

If the export is successful, a zip file of compressed JSON files is returned. Otherwise, an error message is returned.

The following fields are output parameters when an error occurs.

Output Parameter Type Description
message string Message associated with response status code

Response Status

Code Description
Status 200 Successful export.
Status 400 Bad request
Status 401 Unauthorized request
Status 500 Failed to export the data