Result codes and messages
Error codes are reserved up to 10.000, ensuring a dedicated range and reserving space for future codes. The range starting at 10,001 is reserved for TERP v5.
Validation and error messages, often called results, serve as the bridge between users and the intricate processes taking place behind the scenes. They are the means through which users receive feedback about the success, failure, or other outcome of their actions, offering a crucial layer of transparency and guidance. In this exploration, we delve into the significance of validation and error messages, examining the essential elements that contribute to user-centric interactions and the seamless integration of processes.
Global messages
Global messages are usually returned if incorrect or unknown identifiers are passed to the API.
If one of these results is returned, no further actions can be performed. The severity of these messages can be classified as high.
| Code | Category | Name | Severity | Internal Usage |
|---|---|---|---|---|
| 1001 | General | CartLookup | low | |
| 1002 | EventNotFound | low | Create | |
| 1003 | UserLookup | low | SetUser | |
| 1004 | OrderDetailLookup | low | GetOrderDetailHandler | |
| 1005 | CartLockStatus Cart cannot be locked because it already is. | low | CartStore | |
| 1006 | CartUpdateStatus Cart cannot be updated. | high | CartStore | |
| 1007 | CartLockability Cart cannot be locked, but it needs to be to be processed. | high | CartStore | |
| 1008 | CartUnlockability | high | CartStore | |
| 1009 | CartUserAssignmentStatus | high | PersonRegistrationService | |
| 1010 | RequestStatus | low | ||
| 1011 | CharsetFilter | low | ||
| 1013 | CartCreationStatus | low | ||
| 1014 | TosApprovalStatus | low | ||
| 1015 | MailingPreferenceCategoryMandatory | low |
Validation messages
The validation of a cart can be called up at any time and contains various codes in response that reflect the status of the cart to be checked.
These results are informative messages. However, before a checkout is carried out, the validation result may no longer provide any results. Validation is carried out automatically before a checkout. The severity of these messages can be classified as low.
| Code | Category | Name | Severity | Auto Resolve | Internal Usage |
|---|---|---|---|---|---|
| 2001 | General | ArticleValidation | low | not implemented | Validate |
| 2002 | CartStatus | low | not implemented | Validate | |
| 2003 | CartItemPresence | low | not implemented | Validate | |
| 2004 | UserAssignmentStatus | low | not implemented | Validate | |
| 2005 | PriceValidation | low | not implemented | Validate | |
| 2006 | RegistrationActiveStatus | low | not implemented | Validate | |
| 2007 | SaleActiveStatus | low | not implemented | Validate | |
| 2008 | VatValidation | low | not implemented | Validate | |
| 2009 | RegistrationReminderEligibility | low | not implemented | ResendRegistrationReminderEmailHandler | |
| 2010 | RegistrationReminderOrder | low | not implemented | ResendRegistrationReminderEmailHandler | |
| 2011 | RegistrationReminderStatus | low | not implemented | ResendRegistrationReminderEmailHandler | |
| 2012 | RegistrationReminderOwnership | low | not implemented | ResendRegistrationReminderEmailHandler | |
| 2013 | ValidatorStatus | low | not implemented | ValidateCartHandler | |
| 2015 | CartAmountStatus | low | not implemented | Validate | |
| 2016 | CartLegitimationStatus | low | not implemented | Validate | |
| 2017 | CartPaymentStatus The payment for the cart is not allowed to be changed. | low | not implemented | Validate | |
| 2019 | ItemArticleGroupContingentAssignment | low | available | Validate | |
| 2020 | ItemTimeslotBookingStatus | low | not implemented | Validate | |
| 2021 | ItemTimeslotBookingLimit | low | not implemented | Validate | |
| 2022 | ItemBookedTimeslotAvailability | low | not implemented | Validate | |
| 2023 | RegistrationReminderPayment | low | not implemented | ResendRegistrationReminderEmailHandler | |
| 2024 | ItemTicketAttributeContingentStatus | low | not implemented | Validate | |
| 2101 | Buyer | BillingValidation | low | not implemented | Validate |
| 2102 | BuyerValidation | low | not implemented | Validate | |
| 2103 | BuyerPresence | low | not implemented | Validate | |
| 2201 | Registration | ArticlePromotionTimespan | low | not implemented | Validate |
| 2203 | SurveyItemSelfRegistration | low | not implemented | Validate | |
| 2204 | ItemRegistrationTypeStatus | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2205 | ItemRegistrationRequirement | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2206 | ItemReservationStatus | low | not implemented | Validate | |
| 2207 | RegistrationForItemStatus | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2208 | RegistrationResponseValidation | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2209 | RegistrationTypeLookup | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2210 | PrefilledRegistrationAnswersStatus | low | not implemented | ValidateCartItemRegistrationHandler | |
| 2211 | SurveyAnswersConsistency | low | not implemented | Validate | |
| 2212 | TicketOwnerPersonMatch | low | not implemented | TicketOwnerUniquenessValidator | |
| 2213 | TicketOwnerUsageStatus | low | not implemented | TicketOwnerUniquenessValidator | |
| 2301 | Payment | PaymentAmountValidation | low | not implemented | Validate |
| 2302 | PaymentExpirationStatus | low | not implemented | Validate | |
| 2303 | PaymentAssignmentStatus | low | not implemented | Validate | |
| 2401 | Limit | AttendeeTicketLimitStatus | low | not implemented | Validate |
| 2402 | ArticleLimitStatus | low | not implemented | Validate | |
| 2403 | ArticleAssortmentLimitStatus | low | not implemented | Validate | |
| 2404 | ArticleGroupLimitStatus | low | not implemented | Validate | |
| 2405 | AttendeeTicketDaysLimit | LOW | not implemented | Validate | |
| 2406 | CartItemTicketDaysLimit | LoW | not implemented | ValidateCartItemRegistrationHandler | |
| 2407 | AttendeePermanentTicketStatus | LoW | not implemented | Validate | |
| 2408 | CartItemPermanentTicketStatus | LoW | not implemented | ValidateCartItemRegistrationHandler | |
| 2409 | CartItemTicketLimitStatus | LoW | not implemented | ValidateCartItemRegistrationHandler | |
| 2501 | Legitimation | LegitimationCountryEligibility | low | not implemented | Validate |
| 2502 | LegitimationProofsStatus | low | not implemented | Validate | |
| 2503 | LegitimationUploadFormat | low | not implemented | Validate | |
| 26xx | Survey | Placeholder for survery validation results | low | not implemented |
Cart messages
The cart area concerns all actions that modify or change a cart.
These results prevent the corresponding cart from being changed. Depending on the result, previous actions on the cart may be necessary. The severity of these messages can be classified as medium.
| Code | Category | Name | Severity | Internal Usage |
|---|---|---|---|---|
| 3001 | General | ArticleOrderStatus The information for processing the ticket order is missing. This includes the information regarding the ordering process like shipping information. | low | AddItem |
| 3002 | ArticleTicketAvailability | low | AddItem | |
| 3003 | ArticleLookup | low | AddItem | |
| 3004 | ArticleEventAssignment | low | AddItem | |
| 3005 | ArticleForCartValidation | low | AddItem | |
| 3006 | ArticleQuantityValidation | low | AddItem | |
| 3007 | SurveyReference | low | UpdateItemRegistration | |
| 3008 | ItemLookup | low | UpdateItemRegistration | |
| 3009 | RegistrationTypeAvailability | low | UpdateItemRegistration | |
| 3010 | RegistrationConfigurationLookup The registration configuration contains the information whether the ticket registration is required and/or possible as well as the ticket registration type. | low | PersonRegistrationService | |
| 3011 | RegistrationInformationLookup The ticket registration is required but the item is missing the survey information. | low | PersonRegistrationService | |
| 3012 | RegistrationSurveyLookup | low | PersonRegistrationService | |
| 3013 | RegistrationSurveyBind | low | PersonRegistrationService | |
| 3014 | ArticleReservation | low | AddItem | |
| 3015 | CartAssortmentStatus | low | ExclusiveAssortmentGuard | |
| 3016 | RecommendationItems | low | ApplyRecommendations | |
| 3101 | Limit | ArticleLimit | low | AddCoupon,AddItem |
| 3102 | ArticleLimitPerAttendee | low | AddCoupon,AddItem | |
| 3103 | ArticleAssortmentLimit | low | AddItem | |
| 3104 | ArticleGroupLimit | low | AddItem | |
| 3105 | ArticleVoucherLimit | low | AddCoupon | |
| 3106 | ArticleGroupContingent | low | AddItem | |
| 3107 | ArticleMinimumLimit | low | AddItem | |
| 3108 | CartVoucherLimit | low | AddCoupon | |
| 3201 | Voucher | TicketCodeRegistrationStatus | low | RegistrationResult |
| 3202 | AlreadyReservedTicketCode | low | RegistrationResult | |
| 3203 | EmptyTicketPool | low | RegistrationResult | |
| 3204 | InvalidRegistrationData | low | RegistrationResult | |
| 3205 | LockedTicketCode The voucher code has been blocked. | low | RegistrationResult | |
| 3206 | TicketAlreadyInCart | low | RegistrationResult | |
| 3207 | TicketCanceled | low | RegistrationResult | |
| 3208 | TicketCodeForAnotherFairevent | low | RegistrationResult | |
| 3209 | TicketCodeUsedUp | low | RegistrationResult | |
| 3210 | TicketOwnerLacksValidLegitimation | low | RegistrationResult | |
| 3211 | UnkownTicketCode | low | RegistrationResult | |
| 3212 | VoucherOwnership | low | AddCoupon | |
| 3213 | WrongReservationGUID | low | RegistrationResult | |
| 3301 | PromotionCode | Group for Promotion Codes responses. Will be added later | low | |
| 3401 | Legitimation | LegitimationProofTypeStatus | low | AddLegitimationHandler |
| 3501 | Registration | RegistrationValidation | LOW | UpdateItemRegistrationHandler |
| 3601 | Timeslots | TimeslotsBookingDayRequest | LOW | SetCartItemTimeslotsHandler ShopTimeslotService |
| 3602 | TimeslotsBookingItemAvailability | LOW | ||
| 3603 | TimeslotsBookingDayExistence | LOW | ||
| 3604 | TimeslotsBookingTimeRangeExistence | LOW | ||
| 3605 | TimeslotsBookingTimeRangeRequirement | LOW | ||
| 3606 | TimeslotsBookingDayRequirement | LOW | ||
| 3607 | TimeslotsBookingDaysRequested | LOW | ||
| 3608 | TimeslotsBookingDaysLimit | LOW | ||
| 3609 | TimeslotsBookingDayAvailability | LOW | ||
| 3610 | TimeslotsBookingTimeRangeAvailability | LOW | ||
| 3611 | TimeslotsBookingUniqueDayAndTimeResult | LOW |
Payment messages
The payment area concerns all actions that link a payment provider to a cart. These are not yet problems or errors during the execution of a payment.
These results prevent the assignment of payment providers. In the case of a sales transaction, it is not possible to continue with a checkout. If a payment provider cannot be accepted and a checkout is carried out, this is prevented by the validation. The severity of these messages can be classified as medium.
| Code | Category | Name | Severity | Internal Usage |
|---|---|---|---|---|
| 4001 | General | ExpressCartData | medium | InitializeExpressPayment |
| 4002 | CartPaymentAssignmentStatusResult | medium | RemovePaymentProvider | |
| 4003 | PaymentInitialization | medium | InitializeExpressPayment | |
| 4006 | PaymentStatus | medium | SetPaymentProvider | |
| 4007 | PaymentProviderLookup | medium | SetPaymentProvider |
Checkout messages
The results from the checkout area are exclusively errors that can occur during the completion of a sale or registration.
If one of these results occurs, the checkout cannot be continued. Depending on the result, this can lead to a support case. The severity of these messages can be classified as high.
| Code | Name | Severity | Internal Usage | |
|---|---|---|---|---|
| 5001 | General | CheckoutSaleAssignment | high | Checkout |
| 5003 | CheckoutConfirmationMail | high | Checkout | |
| 5004 | CheckoutSaleStatus | high | Checkout | |
| 5005 | CheckoutCartSaleStatus | high | Checkout | |
| 5006 | CheckoutBuyerDataStore | high | Checkout | |
| 5007 | CheckoutSaleActions | high | Checkout | |
| 5008 | CheckoutBuyerData | high | Checkout | |
| 5009 | CheckoutSaleBinariesAssignment | high | Checkout | |
| 5101 | Payment | CheckoutPaymentCapture | high | Checkout |
| 5102 | CheckoutPaymentCaptureStatus | high | Checkout | |
| 5103 | CheckoutPaymentReservation | high | Checkout | |
| 5104 | CheckoutPaymentReservationStatus | high | Checkout | |
| 5201 | Registration | CheckoutPromotionCodeRedemption | high | Checkout |
| 5202 | CheckoutTicketRegistration | high | Checkout | |
| 5203 | CheckoutTicketSaleAttachment | high | Checkout | |
| 5204 | CheckoutTicketRegistrationStatus | high | Checkout | |
| 5301 | Legitimation | CheckoutLegitimationPersonAssignment | high | CreateLegitimationsFilter |
Social events messages
The social event area concerns all actions, regarding all social interactions with the shop api.
| Code | Name | Severity | Internal Usage | |
|---|---|---|---|---|
| 6001 | General | SocialEventValidation | low | CreateSocialEvent |
| 6002 | SocialEventSaleValidation | low | ||
| 6003 | SocialEventPersonValidation | low | ||
| 6004 | SocialEventUserValidation | low | ||
| 6005 | SocialEventUserProfileValidation | low | ||
| 6006 | SocialEventNetworkValidation | low | ||
| 6007 | SocialEventContentStatus | low | ||
| 6100 | SocialCards | SocialCardConfigurationStatus | MEDIUM | CreateSocialCard |
| 6101 | SocialCardApiKeyValidation | High | ||
| 6102 | SocialCardUserPersonAssignment | low | ||
| 6103 | SocialCardUserProfilePictureStatus | low | ||
| 6104 | SocialCardUserEventStatus | low | ||
| 6110 | SocialCardLookup | low | GetSocialCard | |
| 6200 | Shares | SharingStatus | High | Share |
| 6201 | SharingTokenPresence | MEDIUM | ||
| 6202 | SharingTokenValidation | MEDIUM |
Byndr messages
Byndr related processes and messages.
| Code | Name | Severity | Internal Usage | |
|---|---|---|---|---|
| 7001 | General | QuicodeValidation | low | |
| 7002 | InitiatorUserLookup | low | ||
| 7003 | TargetUserLookup | low | ||
| 7004 | DailyConnectionStatus | low | ||
| 7005 | EventLookup | low | ||
| 7006 | InitiatorUserEligibility | low |
Remarks
The severity level is also used as the internal debugging levels.