diff --git a/projects/authentication/docs/requesting-credentials.md b/projects/authentication/docs/requesting-credentials.md index ae110eaf..b4dab644 100644 --- a/projects/authentication/docs/requesting-credentials.md +++ b/projects/authentication/docs/requesting-credentials.md @@ -1,12 +1,14 @@ # Requesting client credentials ## UiTPAS API & UiTdatabank APIs + Before you can start making authenticated API requests to UiTPAS and/or UiTdatabank, you need to register your integration on our self-service platform [publiq platform](https://platform.publiq.be). In the registration process you'll need to pick the API you want to use: + * [UiTPAS API](https://docs.publiq.be/docs/uitpas/introduction) * [UiTdatabank Entry API](https://docs.publiq.be/docs/uitdatabank/entry-api/introduction) * [UiTdatabank Search API](https://docs.publiq.be/docs/uitdatabank/search-api/introduction) -Note that the UiTPAS API will also grant you access to the UiTdatabank Entry API. +Note that the UiTPAS API will also grant you access to the UiTdatabank Entry API. Registration and access to our test environment is free. After registration you'll immediately get your test credentials. diff --git a/projects/release-notes/docs/uitdatabank/2024.md b/projects/release-notes/docs/uitdatabank/2024.md index 2ceaf41c..051f34cc 100644 --- a/projects/release-notes/docs/uitdatabank/2024.md +++ b/projects/release-notes/docs/uitdatabank/2024.md @@ -4,17 +4,18 @@ 🛠 **Improvements** -User interface: +User interface: + * it is now possible to save executed searches on an existing saved search, besides creating a new saved search. * executed searches are now added as an URL parameter in your browser URL, making it possible to share a direct URL to an executed search, e.g. an URL to all online events with at least one videolink: `https://www.uitdatabank.be/search?query=attendanceMode%3Aonline+AND+videosCount%3A1`. * the query builder now allows you to start from an executed search and edit the search. - ## February 15 ✨ **New features** For every event, place & organizer created in UiTdatabank we now store its `completeness`. The completeness score is a number between 0 and 100 that indicates how complete the information of an event, place or organizer is. + * Using the [avanced query field completeness](https://docs.publiq.be/docs/uitdatabank/search-api%2Fadvanced-queries#completeness) you can filter events, places and organizers by their completeness score. * Using the [sort parameter completeness](https://docs.publiq.be/docs/uitdatabank/search-api%2Fsorting#completeness) you can now sort data you retrieve from the API by its completeness. diff --git a/projects/release-notes/docs/widgets/2024.md b/projects/release-notes/docs/widgets/2024.md index 216e5e87..12ec053a 100644 --- a/projects/release-notes/docs/widgets/2024.md +++ b/projects/release-notes/docs/widgets/2024.md @@ -10,7 +10,6 @@ * Points required for an UiTPAS reward are now also displayed in the UiTPAS reward section on the detail page. * Reservation e-mail on the detail page is now a clickable mailto link. - ## January 16 ✨ **New features** diff --git a/projects/uitdatabank/docs/entry-api/shared/labels.md b/projects/uitdatabank/docs/entry-api/shared/labels.md index cffadf6b..acb6a369 100644 --- a/projects/uitdatabank/docs/entry-api/shared/labels.md +++ b/projects/uitdatabank/docs/entry-api/shared/labels.md @@ -60,7 +60,7 @@ Alternatively, you can set a label using one of these endpoints: To remove a label **when updating an event/place/organizer in its entirety**, you can simply leave out the specific `label`. -> + > Exception: some existing labels or hiddenLabels may be kept on the event, even if they are not included in the update request. For example, if they were added via the UiTdatabank UI, or if the client or user making the request does not have sufficient permission to remove some specific labels. Alternatively, you can delete a label using one of these endpoints: diff --git a/projects/uitdatabank/docs/search-api/advanced/advanced-queries.md b/projects/uitdatabank/docs/search-api/advanced/advanced-queries.md index 8b41bd70..b2280fbb 100644 --- a/projects/uitdatabank/docs/search-api/advanced/advanced-queries.md +++ b/projects/uitdatabank/docs/search-api/advanced/advanced-queries.md @@ -288,9 +288,11 @@ GET /organizers/?q=completedLanguages:en ``` ### completeness + > #### New functionality 🚧 +> > `completeness` is a new parameter that is still under construction. At the moment the completeness is only calculated for events, places and organizers created after February 15, 2024. With the `completeness` field you can filter events, places and organizers by their completeness score. The completeness score is a number between 0 and 100 that indicates how complete the information of an event, place or organizer is. diff --git a/projects/uitdatabank/docs/search-api/authentication.md b/projects/uitdatabank/docs/search-api/authentication.md index 0a5e8c10..f44a7a39 100644 --- a/projects/uitdatabank/docs/search-api/authentication.md +++ b/projects/uitdatabank/docs/search-api/authentication.md @@ -96,7 +96,7 @@ Host: https://search-test.uitdatabank.be API key authentication will be supported for the foreseeable future on Search API. However, if you already want to make your integration as future-proof as possible you can easily switch from API key authentication to client identification. -On our [self-service portal](https://platform.publiq.be) you are able to request a client id for your existing integration. +On our [self-service portal](https://platform.publiq.be) you are able to request a client id for your existing integration. When you receive your new client id, you can update your application to include the client id in your API requests as described above using an `x-client-id` header instead of an `x-api-key` header, or a `clientId` query parameter instead of an `apiKey` query parameter. diff --git a/projects/uitdatabank/docs/search-api/filters/booking-availability.md b/projects/uitdatabank/docs/search-api/filters/booking-availability.md index 7fc5d63b..956dc68a 100644 --- a/projects/uitdatabank/docs/search-api/filters/booking-availability.md +++ b/projects/uitdatabank/docs/search-api/filters/booking-availability.md @@ -12,8 +12,8 @@ All events and places created in UiTdatabank have a `bookingAvailability` proper **Possible values** -- `Available`: there are still tickets or seats left for the event, or the capacity for the event is unlimited. -- `Unavailable`: the event is sold out or fully booked. +* `Available`: there are still tickets or seats left for the event, or the capacity for the event is unlimited. +* `Unavailable`: the event is sold out or fully booked. **Examples** diff --git a/projects/uitdatabank/docs/search-api/filters/default-filters.md b/projects/uitdatabank/docs/search-api/filters/default-filters.md index a6d83e12..8ef58a6e 100644 --- a/projects/uitdatabank/docs/search-api/filters/default-filters.md +++ b/projects/uitdatabank/docs/search-api/filters/default-filters.md @@ -66,7 +66,7 @@ GET /offers/?workflowStatus=*&addressCountry=*&audienceType=* ## Disable all filters at once -In order to disable all filters at once you can set the `disableDefaultFilters` parameter to `true`. +In order to disable all filters at once you can set the `disableDefaultFilters` parameter to `true`. ``` GET /offers/?disableDefaultFilters=true diff --git a/projects/uitdatabank/docs/search-api/filters/status.md b/projects/uitdatabank/docs/search-api/filters/status.md index c03bd81c..bd7d54cf 100644 --- a/projects/uitdatabank/docs/search-api/filters/status.md +++ b/projects/uitdatabank/docs/search-api/filters/status.md @@ -1,16 +1,18 @@ # Status -All events and places created in UiTdatabank have a `status` property. The status indicates whether -- an event is still happening as plannend or not -- a place is still open for visits or not +All events and places created in UiTdatabank have a `status` property. The status indicates whether + +* an event is still happening as plannend or not +* a place is still open for visits or not > The status only indicates whether an event or place is proceeding as planned or is currently open. It does not provide information about the availability of tickets or spots, which is instead indicated by the [bookingAvailability](#booking-availability.md). ## Using the status parameter You can use the `status` for filtering out items that are still available for visits or not. You can use the status filter as: -- an url parameter (e.g. `status=available`) -- an advanced query parameter (e.g. `status:avaialble`) + +* an url parameter (e.g. `status=available`) +* an advanced query parameter (e.g. `status:avaialble`) **Applicable on endpoints** @@ -19,14 +21,16 @@ You can use the `status` for filtering out items that are still available for vi **Possible values** Events: -- `available`: the event takes place as planned This is the default value when no status for the event or subEvent is included. -- `temporarilyUnavailable`: the event has been postponed to a later date yet to be determined. -- `unavailable`: the event has been cancelled. - -Places: -- `available`: the place is 'open' and can be visited during opening hours. This is the default value when no status for the place is included. -- `temporarilyUnavailable`: the place is temporarily closed (due to renovations for example). -- `unavailable`: the place still exists (physically), but is permanently closed. + +* `available`: the event takes place as planned This is the default value when no status for the event or subEvent is included. +* `temporarilyUnavailable`: the event has been postponed to a later date yet to be determined. +* `unavailable`: the event has been cancelled. + +Places: + +* `available`: the place is 'open' and can be visited during opening hours. This is the default value when no status for the place is included. +* `temporarilyUnavailable`: the place is temporarily closed (due to renovations for example). +* `unavailable`: the place still exists (physically), but is permanently closed. **Examples** diff --git a/projects/uitpas/docs/getting-started.md b/projects/uitpas/docs/getting-started.md index a4e9cf67..04467434 100644 --- a/projects/uitpas/docs/getting-started.md +++ b/projects/uitpas/docs/getting-started.md @@ -10,7 +10,7 @@ On this page we outline the basic steps to integrate your application with UiTPA ## 1. Start on the test environment -Create an integration on publiq platform, our self-service portal to request your credentials for the UiTPAS testing environment. +Create an integration on publiq platform, our self-service portal to request your credentials for the UiTPAS testing environment. diff --git a/projects/uitpas/docs/registering-events.md b/projects/uitpas/docs/registering-events.md index 08215440..30ac0da3 100644 --- a/projects/uitpas/docs/registering-events.md +++ b/projects/uitpas/docs/registering-events.md @@ -55,7 +55,8 @@ Click on the `Prijzen` tab in step 6, and provide a *Basistarief* that is not 0 ### 3. Linking an UiTPAS organizer -Click the `Organisatie toevoegen` tab. You can now either +Click the `Organisatie toevoegen` tab. You can now either + * select an organizer you have used in the past for creating events * select a new organizer @@ -65,14 +66,12 @@ UiTPAS organizers always have a grey `UiTPAS` badge next to them. ![](../assets/images/uitdatabank-uitpas-event-organizer.png) - Once you have added your UiTPAS organizer, the applicable UiTPAS prices are automatically calculated by UiTdatabank: ![](../assets/images/uitdatabank-uitpas-event-price-calculated.png) - ### 4. Done! Shortly after you have selected an UiTPAS organizer, you should see a new *UiTPAS* field appear in the form that looks like this: @@ -81,7 +80,6 @@ Shortly after you have selected an UiTPAS organizer, you should see a new *UiTPA ![image.png](../assets/images/uitdatabank-uitpas-event-cardsystems.png) - **If you see this field, your event is now registered as an UiTPAS event**, and you can optionally change the possible card systems that it belongs to if the UiTPAS organizer is active in multiple card systems. You can now **use its id in UiTPAS API requests** that require an event id, for example to register a ticket sale for it. You can find this id in the URL of the event's detail or edit page on UiTdatabank. diff --git a/projects/uitpas/docs/test-dataset.md b/projects/uitpas/docs/test-dataset.md index 2b5d3ee5..03052e57 100644 --- a/projects/uitpas/docs/test-dataset.md +++ b/projects/uitpas/docs/test-dataset.md @@ -56,7 +56,7 @@ When testing ticket sale requests, you'll need an UitpasNumber of a passholder. ## Group passes -| UitpasNumber | Chip Number | Social tariff | Coupons | Card status | Comment | +| UitpasNumber | Chip Number | Social tariff | Coupons | Card status | Comment | | --------------- | :--------------: | :-----------: | :-----: | :---------: | :-------------------------: | | `0900000045410` | `04D0AB6AF85C80` | yes | no | active | - | | `0900000191800` | `048B25DAEE3880` | no | yes | active | max. 50 ticketsales per day | @@ -69,7 +69,7 @@ If you want to test rewards without creating your own rewards, you can use these | --------------------------------- | :----: | :-------: | :------------------: | | Test Voordeel Regio Gent | `5687` | `POINTS` | Without restrictions | | Test Welkomstvoordeel Regio Gent | `5688` | `WELCOME` | Without restrictions | -| Test Voordeel Regio Gent - 1/week | `5823` | `POINTS` | 1 per week | +| Test Voordeel Regio Gent - 1/week | `5823` | `POINTS` | 1 per week | | Test Online Voordeel - 10/dag | `5824` | `POINTS` | Online Reward 10/day | -| Test Vervallen Voordeel | `5825` | `POINTS` | Should not work | -| Test Vervallen Welkomsvoordeel | `5826` | `WELCOME` | Should not work | +| Test Vervallen Voordeel | `5825` | `POINTS` | Should not work | +| Test Vervallen Welkomsvoordeel | `5826` | `WELCOME` | Should not work |