Issuing API (v5) Migration Guide

When migrating your Issuing client application from v4 to v5 of the Issuing API the following changes should be considered:

Products

When requesting product information, a new property validityScheduleName in the response will show the name of the validity schedule that is linked to this product, if there is one. This string is for informational purposes to the client, and shows if the ticket is an "off peak" product. Examples of validity schedule names are "Daluren" or "School Holidays".

In the ProductSummary and ProductDetails response classes, the property priceInCents and groupSizeProces have been renamed to prices be consistent and clearify it is a list of prices. The structure of the list itself is unchanged.

Create Tickets

When creating a ticket for a product which has a validity schedule, the create ticket response will contain the validityScheduleName property with the name of the validity schedule linked to the ticket. Note that once the ticket is created, the schedule cannot be changed afterwards for that Ticket.

Reduced and Full Ticket Info

When getting ticket information from the /info or /full-info endpoints, the validityScheduleName property will be present as described above.