| Resource | Description |
|---|---|
| GET passes | Returns descriptions of all created passes |
| GET passes/:passTypeIdentifier | Returns descriptions of all passes for a given Pass Type ID |
| GET passes/:passTypeIdentifier/:serialNumber | Downloads a given pass (.pkpass file including JSON, signature and images) |
| GET passes/:passTypeIdentifier/:serialNumber/passjson | Returns the full pass description of the given pass |
| DELETE passes/:passTypeIdentifier/:serialNumber | Deletes the pass |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/values | Returns the placeholder values of the pass |
| PUT passes/:passTypeIdentifier/:serialNumber/values | Updates the placeholder values values of the pass |
| Resource | Description |
|---|---|
| GET passes/:passTypeIdentifier/:serialNumber/images | Returns all images of the pass (template images not included) |
| DELETE passes/:passTypeIdentifier/:serialNumber/images | Deletes all images of the pass (template images not included) |
| GET passes/:passTypeIdentifier/:serialNumber/images/:type | Returns all images with the given type of the pass (template images not included) |
| DELETE passes/:passTypeIdentifier/:serialNumber/images/:type | Deletes all images with the given type of the pass (template images not included) |
| GET passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Returns the image with the given type and resolution of the pass (template images not included) |
| POST passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Creates or updates the image with the given type and resolution of the pass |
| DELETE passes/:passTypeIdentifier/:serialNumber/images/:type/:resolution | Deletes the image with the given type and resolution of the pass (template images not included) |
| Resource | Description |
|---|---|
| GET templates | Returns descriptions of all created pass templates |
| POST templates | Creates a new pass template |
| GET templates/:id | Shows a pass template |
| PUT templates/:id | Updates the template |
| DELETE templates/:id | Deletes the template |
| Resource | Description |
|---|---|
| POST templates/:id/pass (Variant 1) | Creates a pass from the pass templates with values |
| POST templates/:id/pass (Variant 2) | Creates a pass from the pass templates with values and images |
| POST templates/:id/names/:name/pass (Variant 1) | Creates a pass from the pass template with the given name using the supplied values |
| POST templates/:id/names/:name/pass (Variant 2) | Creates a pass from the pass template with the given name using the supplied values and images |
| Resource | Description |
|---|---|
| GET templates/:id/images | Returns all images of the pass template |
| DELETE templates/:id/images | Deletes all images of the pass template |
| GET templates/:id/images/:type | Returns all images with the given type of the pass template |
| DELETE templates/:id/images/:type | Deletes all images with the given type of the pass template |
| GET templates/:id/images/:type/:resolution | Returns the image with the given type and resolution of the pass template |
| POST templates/:id/images/:type/:resolution | Creates or updates the image with the given type and resolution of the pass template |
| DELETE templates/:id/images/:type/:resolution | Deletes the image with the given type and resolution of the pass template |
