Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UPS-5304 add cardStatus to grouppass #423

Merged
merged 1 commit into from
Jan 28, 2025
Merged

UPS-5304 add cardStatus to grouppass #423

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion projects/uitpas/reference/uitpas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2125,6 +2125,7 @@
"id": "b5a5bb75-6cae-452b-b029-d12d3b425b1b",
"name": "Test groep",
"uitpasNumber": "0900000045410",
"cardStatus": "ACTIVE",
"email": "[email protected]",
"creationDate": "2019-08-24T14:15:22Z",
"socialTariff": {
Expand Down Expand Up @@ -2188,7 +2189,7 @@
}
},
"operationId": "get-grouppasses",
"description": "Retrieve grouppasses based on search parameters.\n\n**Note**: For now this endpoint requires either `uitpasNumber` or `chipNumber`, so this endpoint currently cannot be used to search _all_ grouppasses.\n\nThe caller of this request must have `GROUPPASSES_SEARCH` permission.",
"description": "Retrieve grouppasses based on search parameters.\n\n**Note**: For now this endpoint requires either `uitpasNumber` or `chipNumber`, so this endpoint currently cannot be used to search _all_ grouppasses.\n\n<!-- theme: warning -->\n\n> **Important:** This endpoint might return `grouppass` entities for `BLOCKED` or `DELETED` cards. Clients using this endpoint MUST check `cardStatus` for `ACTIVE` cards before proceeding regular operations with this `grouppass`.\n\nThe caller of this request must have `EVENTS_READ` permission for the organizer of this event.\n\nThe caller of this request must have `GROUPPASSES_SEARCH` permission.",
"security": [
{
"USER_ACCESS_TOKEN": []
Expand Down Expand Up @@ -7985,6 +7986,20 @@
"type": "string",
"description": "The UiTPAS number of this grouppass. This field is always available in responses."
},
"cardStatus": {
"type": "string",
"x-stoplight": {
"id": "nnzfui82in9z5"
},
"description": "Status of the card linked to this grouppass.",
"enum": [
"PROVISIONED",
"LOCAL_STOCK",
"ACTIVE",
"BLOCKED",
"DELETED"
]
},
"email": {
"type": "string",
"description": "Contact email address of the grouppass."
Expand Down Expand Up @@ -8079,6 +8094,7 @@
},
"required": [
"name",
"cardStatus",
"cardSystem",
"address"
]
Expand Down
Loading