ASP.NET Web API Help Page

Gets the top-level folders.

Gets one folder.

Gets one page of the top-level folders.

Gets the folders directly inside a folder.

Gets one page of the folders directly inside a folder.

Gets one show.

Gets shows, optionally filtered, searched and paged. The filters are all optional and apply together. The X-Total-Count response header has the number of matching shows, for paging.

Gets one performance.

Gets performances, optionally filtered and paged. The filters are all optional and apply together.

Gets one venue.

Gets venues: all of them, or only those below a folder.

Gets one space.

Gets spaces, optionally only those below a folder or at a venue.

Gets one genre.

Gets genres: all of them, or only those below a folder.

Uploads a batch of scans, e.g. made offline by a handheld scanner, and records them. Each scan is validated against the time it was made, not the time it's uploaded. A scan with an empty SessionId is recorded against this session, and so its Access Control Location. An error (500) if the request has no session.

Validates one token scanned now at the session's Access Control Location, and records the scan. An error (500) if the request has no session.

Downloads the tokens a scanner needs. The session must be logged in as a user with the Scanner role who is linked to an Access Control Location. The result is the tokens for products that use the Access Control Schemes linked to that location, where the product's performance is within the scheme's active times. An error (500) if the request has no session.

Gets the session's basket, with packages (multi-buy offers) worked out again. Null if the request has no session.

Adds products, or a package, to the session's basket. Each item group adds a quantity of a product at a concession. ItemId picks a specific item, such as a seat from the seating plan, and applies to every group with a quantity above 0. PackageId applies a package and checks the basket now qualifies for it. Responses: 200 with the request echoed back. 401 if the request has no session. An error (500) if the items are sold out or not on sale, or the basket doesn't qualify for the package.

Clears the whole cache, for every session. Needs a valid session token: 401 otherwise. Send the session as a bearer token: "Authorization: Bearer {sessionId}", using the Id returned by PUT api/Session.

Gets custom form values by form data ID, the ID the other CustomForm endpoints look up.

Gets the custom form values for a genre: the extra fields set up for genres in Monad. Responses: 200 with the values. 404 if the genre doesn't exist or has no custom form. An error (500) if genreId isn't a GUID.

Gets the custom form values for a performance: the extra fields set up for performances in Monad. Responses: 200 with the values. 404 if the performance doesn't exist or has no custom form. An error (500) if performanceId isn't a GUID.

Gets the custom form values for a show: the extra fields set up for shows in Monad. Responses: 200 with the values. 404 if the show doesn't exist or has no custom form. An error (500) if showId isn't a GUID.

Gets the custom form values for a space: the extra fields set up for spaces in Monad. Responses: 200 with the values. 404 if the space doesn't exist or has no custom form. An error (500) if spaceId isn't a GUID.

Gets the custom form values for a venue: the extra fields set up for venues in Monad. Responses: 200 with the values. 404 if the venue doesn't exist or has no custom form. An error (500) if venueId isn't a GUID.

Gets a delivery document with its content and file name, ready to print. Responses: 200 with the document, or 200 with null if no document has this ID. A 404 means the URL is wrong, not that the document is missing.

Marks a delivery document as delivered. Call it once the document has printed. Responses: 204.

Creates or updates the session's logged-in customer in Ecwid, in the customer group for their current membership, then returns an Ecwid SSO profile for them: the base64 JSON profile, its HMAC-SHA256 signature and a timestamp, separated by spaces. Responses: 200 with the profile. 401 if there's no session token or the session isn't logged in. 404 if the session doesn't exist. 500 if the Lightspeed integration has no Ecwid client ID or secret.

Logs the workstation in and returns its configuration for this session: printers, till drawer, payment terminal, log level, and the XMPP settings it uses to receive print and payment requests. Each call issues a new XMPP password (creating the XMPP account on first login) and records the client version and login time. POST rather than GET for that reason: don't cache it or retry it automatically. Responses: 200 with the configuration. 401 if the Hardware ID or password is wrong. 503 if the server can't reach the XMPP server or its Jabber configuration is missing: try again later.

Reports the outcome of a POSitive WebLink terminal pairing that the server asked for (the CNPPairing XMPP message): the terminal's auth token on success, or the error. The Hardware ID comes from the Authorization header, so a workstation can only complete its own pairing request. Responses: 204 when accepted. 400 if RequestId is missing. 409 if the request has expired, has already completed, or isn't this workstation's pending request.

Gets a package, checked against the session's basket: what it offers and, for each gap (a rule the basket doesn't meet yet), the folders on sale that would fill it.

Gets a refund to make on the card terminal. Responses: 200 with the refund, or 200 with null if no refund has this ID.

Confirms that the terminal made the refund: marks it processed, at the server's current time, and stores the terminal's reference on the refund payment. Responses: 200 with the refund. 404 if the refund or its payment doesn't exist.

Gets a payment request: the amount to take, the payment type and the customer. Responses: 200 with the request, or 200 with null if it no longer exists (it has been confirmed, cancelled or removed). A 404 means the URL is wrong.

Records that the payment failed or was cancelled on the terminal: the request becomes a payment failure, with the error and the terminal's response in its log. Safe to repeat: if the request has already been cancelled, the existing failure is returned. Responses: 200 with the failure. 404 if there's no such request. 409 if the payment has already been confirmed.

Confirms that the terminal took the payment: records the card details and turns the request into a payment. Fields left out default to: PaymentReference "Manual", PaymentMask and CardType empty, PaymentNetAmount the amount requested. Responses: 200 with the payment. 404 if the request no longer exists, which includes a second confirm of the same request.

Locks a payment request so it isn't removed while the payment is in progress. Call it before starting the payment on the terminal. The lock lasts until the request is confirmed or cancelled. Responses: 204.

Replaces the payment request's RequestData: the payment plugin's own data about the payment in progress, such as the terminal's status. The whole value is replaced. Responses: 200 with the updated request. 404 if the request no longer exists.

Gets a product's prices: the price bands (such as seating areas) and concessions (such as Adult and Child) it's sold at, and the price, booking fee and mandatory donation for each combination. prices, fees and donations are keyed by price band ID, then by concession ID.

Gets one product. The same for every session.

Gets products, optionally filtered and paged. The filters are all optional and apply together.

Gets how many of a product are available, and how many there are in all.

Gets a product's seating plan: the background drawing, and every seat with its position, price band and current status. To book a seat, put its Id in BasketRequest.ItemId.

Starts or logs in a session. With no session token and no email: creates an anonymous session, whose basket can be filled before the customer logs in. With no token, and an email and password: logs in, returning the customer's session. With a token, and an email and password: logs that session in as the customer, keeping its basket. With a token and no email: returns that session unchanged. An error (500) if the email or password is wrong.

Logs out and ends the session in the bearer token. Responses: 200, or 404 if the request has no session token.

Creates a customer account. The email address is also the login name. This doesn't log the session in: call PUT api/Session with the same email and password for that. Responses: 200 with the new user's ID. An error (500) if the email or password is missing, or an account already has that email address.

Gets the session's logged-in customer. Needs a valid session token: 401 otherwise. An error (500) if userId isn't the session's own user, or the user doesn't exist.

Gets the current statuses of the session's logged-in customer. An error (500) if there's no session, or userId isn't the session's own user.