Connect API: V1 response codes
The following codes are returned as part of the Result
and/or ExtendedResultCode
properties on most V1 end-points.
The API Reference should provide details of expected error codes for each end-point however this list can be consulted for generic and/or obscure codes that may be useful to the developer.
Code | Name | Description |
---|---|---|
0 | OK | Request succeeded without error |
1 | UnexpectedError | An unexpected exception occurred processing the request |
2 | DBError | Database Error |
3 | MembershipError | Error creating/updating Loyalty membership |
4 | InvalidRequestData | Invalid request data |
5 | CinemaConnectError | The service could not access the requested Cinema server system. The Cinema may be unavailable for ticketing |
6 | LoyaltyConnectError | The service could not connect to the membership system. The Membership service may not be available |
7 | InsufficientPoints | A ticket or membership reward was requested but the Member does not have sufficient points to add the item. This error can also be returned if the reward has time limitations and the current Session does not fall into those boundaries |
8 | SeatsUnavailable | The cinema refused the requested seats because the Session is sold out or selling out and the tickets requested could not be added |
9 | FailedSeatDataRetrieve | Seats have been booked but error occurred retrieving seat data, client can retrieve seat data separately or cancel order |
10 | FailedOrderValueProcess | Seats have been booked but error occurred calculating order total, client can all GetOrder to calculate total or cancel order |
11 | PrepareOrderForCompleteError | Error occurred before performing payment, a retry of the OrderComplete method may be possible |
12 | PaymentDeclined | Payment was declined by the payment provider |
13 | PaymentSystemError | An error occurred contacting the payment provider |
14 | PostChargeCommitError | Error has occurred AFTER payment has been processed and payment could not be voided. Client should either automatically refund booking or inform customer to contact cinema with Booking Number, Card Number, Name etc. |
15 | UnpaidBookingsDisallowed | An Unpaid Booking may be disallowed at the Cinema due to configurable constraints in the Vista system |
16 | VouchersDisallowed | A Booking containing Voucher ticket types may be disallowed at the Cinema due to configurable constraints in the Vista system |
17 | MemberNotFound | The Membership system could not locate an account using the supplied MemberLogin, or the UserSessionId has no Loyalty Member associated with it |
18 | MemberCredentialsInvalid | The membership system reported that the provided credentials were invalid |
19 | LoyaltyTimeout | The configured timeout period elapsed while communicating with the Loyalty/Membership system |
20 | LoyaltyUserNameAlreadyExists | The Members selected UserName or Email Address is not unique in the loyalty system |
21 | LoyaltyNotSupportedAtCinema | The selected cinema does not support Loyalty integration |
22 | MemberEmailIncorrect | The Members Email does not match the system value |
23 | MemberLoginResetDisallowed | The Members Online Login credentials have already been set - and updates to these details have been disallowed via the Service |
24 | PaymentSuccessWithErrors | Multiple payment lines have been included in an order and some have failed, although the transaction overall has been paid in full |
25 | PaymentVoidSuccessPostCommit | At least one payment method succeeded, but circumstances have forced the order to be voided. In this case, the order has already been committed to history and will not accept any further attempts |
26 | PaymentVoidSuccessPreCommit | At least one payment method succeeded, but circumstances have forced the order to be voided. In this case, the order has not been committed to history and retries are allowed |
27 | PaymentVoidSuccessPayTotalMismatch | All payments have succeeded but the payment total does not match the order total. Payments have been voided to allow a retry |
28 | FailedToAllocateCard | All payments have succeeded but the payment total does not match the order total. Payments have been voided to allow a retry |
43 | LoyaltyMemberAlreadyExists | Member already exists in the club. This is driven by the Loyalty system setting PersonUniqueIdentifier. Member is not created |
44 | LoyaltyMovieHasAlreadyBeenGivenARating | SendMovieFeedback for this movie by this user has already been called |
The ExtendedResultCode
property can return the additional codes
Code | Name | Description |
---|---|---|
29 | VoucherPinRequired | A pin number is required for the barcode |
30 | VoucherNotValid | The barcode specified is not valid for the ticket type |
31 | CouldNotAllocateContiguousSeats | The selected seats could not be automatically allocated in a single row |
32 | VoucherPinIncorrect | The pin number provided is not correct for the barcode |
33 | DuplicateVoucher | Request contains a duplicate voucher code |
34 | NoLoyaltyMember | A loyalty member must be logged in through a call ValidateMember |
35 | InvalidTicketRecognitionPair | Cannot find a ticket valid for the specified recognition |
36 | OrderInitFailed | Could not initialise the order |
37 | CardWalletAccessTokenInvalid | The access token was invalid and the card token could not be retrieved |
38 | InsecureCardWalletAccess | To use the wallet a loyalty member must be validated by their username and password |
39 | RefundBookingFailed | Refunding of booking failed |
40 | IncorrectBookingMode | The booking mode of the order is incorrectly set |
41 | AddressNotFound | The address could not be found by the address validation service |
42 | InvalidAddressModuleConfiguration | An Error occurred while configuring/creating the address module |
43 | OfflinePaymentsDisabled | An offline payment was attempted but the Web Service is not configured to allow offline payments |
44 | BookingRefundsDisabled | A refund has been attempted but the Web Service is not configured to allow refunds |
45 | ExternalPaymentsDisabled | An external payment has been attempted but the Web Service is not configured to allow external payments |
46 | EmailChangeAlreadyVerified | This email change has already been verified and carried out |
47 | BookingDoesNotExist | Booking does not exist |
48 | BookingIsNotUnpaid | Booking is not an unpaid booking |
49 | BookingAlreadyCancelled | Booking is already cancelled |
50 | SessionUnavailable | Session is unavailable |
51 | TicketsNotOnSale | Tickets not currently on sale |
52 | LoyaltyMemberIsBannedFromMakingUnpaidBookings | The Loyalty Member associated with the Order is currently banned from making unpaid bookings |
53 | UnableToRetrieveBookingPrintStream | Failed to retrieve booking print stream from Cinema Sales Server |
54 | IncompatibleOrderPurchaseType | Attempting to add tickets to a gift-store order is invalid |
55 | ActiveTabUsingIdentifierAlreadyExists | A Tab already exists with this Id |
56 | PaymentsProcessed | Unable to edit the order as payments for the order have already been made |
57 | PaymentErrorPreCommit | An Error occurred prior to payments being processed. In this case, the order has not been committed to history and retries are allowed |
58 | LoyaltyPaymentDetailsDontMatchLoggedInMember | Cannot process a Loyalty points balance payment with a card or member id that doesn't belong to that member |
59 | ThirdPartyMemberTicketNotApproved | Third party member ticket was not approved |
60 | NumberOfVoucherRedemptionsExceeded | The voucher cannot be redeemed the requested number of times |
61 | OrderCannotBeUniquelyIdentified | Order cannot be uniquely identified |
62 | OrderDoesNotExist | Order does not exist matching the search criteria |
63 | OrderHasBeenRefunded | The order has been refunded |
64 | TicketPriceOverrideDisallowed | Ticket Price Override is Disallowed |
65 | BookingFeeOverrideDisallowed | Booking fee Override is Disallowed |
66 | CompleteOrderWithoutPerformingPaymentDisallowed | Complete order without performing payment disallowed |
67 | SeatMapRequestedForSoldOutSession | Seat map data for a sold-out session was requested |
68 | TicketTypeNotFound | Ticket type was not found for the request |
69 | PaymentValueNotEqualOrderTotal | When order PaymentValueinCents is not equal to TotalPrice |
70 | BookingFeeOverrideMustBeProvided | Booking fee must be provided |
71 | ConnectApiTokenNotSpecified | Connect API token must be provided |
72 | ConnectApiTokenInvalid | Connect API token is invalid |
73 | SiteNotFound | The site could not be found |
74 | SiteApiRouterSettingsInvalid | The site API router settings are invalid |
75 | SiteApiRouterSettingsNotFound | The site API router settings could not be found |
76 | VenueFacilityNotFoundForSite | The venue facility could not be found at the site |
77 | VenueFacilitiesNotRetrievedForSite | The venue facilities could not be retrieved for the site |
78 | BookingNotFound | The venue facility booking could not be found |
79 | ConnectApiTokenForbidden | Connect API token is forbidden |
80 | BookingPaymentDataMismatch | Booking cinema id or transaction number does not match the payment details |
81 | PaymentDoesNotExist | Payment does not exist |
82 | WebPaymentModuleConnectionFailed | Failed to connect to Web Payment Module |
83 | OrderIsAlreadyBeingCompleted | Order is already being completed |
84 | TicketBookingFeeOverrideDisallowed | Ticket Booking fee Override is Disallowed |
85 | ProcessDefinitionNotFoundForId | The Process Definition was not found for the process ID |
86 | CinemaPaymentVoidFailed | The payment failed to be voided at cinema |
87 | SelectedSeatsInvalidForTickets | Selected seats were not valid for the tickets in the order |
88 | DeviceTokenMissing | Device token must be specified for Android or iOS notifications |
89 | PhoneNumberMissing | Phone number must be specified for SMS notifications |
90 | PaymentNotStarted | Payment hasn't been started on this order |
91 | FailedLoyaltyMembershipActivation | Loyalty member activation failed |
92 | OrderLockedForAsynchronousCompletion | Order is locked as it is being completed asynchronously |
93 | DealDoesNotExist | The specified does not exist |
94 | VssUpdateOrderFailed | UpdateOrder at Sales Server failed |
95 | DealCannotBeApplied | The deal cannot be applied because a better one is already applied |
96 | LoyaltyCardPinNumberRequired | Loyalty card pin number required for logging in and wasn't provided |
97 | LoyaltyCardNumberRequired | Loyalty card number required for logging in and wasnt provided |
98 | ExternalCardWalletUnavailable | When external card wallet is unavailable. Could be due to authentication error or the payment provider is not accessible |