ADITUS/Guidelines/Result codes and messages

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.

CodeCategoryNameSeverityInternal Usage
1001GeneralCartLookuplow
1002EventNotFoundlowCreate
1003UserLookuplowSetUser
1004OrderDetailLookuplowGetOrderDetailHandler
1005CartLockStatus

Cart cannot be locked because it already is.
lowCartStore
1006CartUpdateStatus

Cart cannot be updated.
highCartStore
1007CartLockability

Cart cannot be locked, but it needs to be to be processed.
highCartStore
1008CartUnlockabilityhighCartStore
1009CartUserAssignmentStatushighPersonRegistrationService
1010RequestStatuslow
1011CharsetFilterlow
1013CartCreationStatuslow
1014TosApprovalStatuslow
1015MailingPreferenceCategoryMandatorylow

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.

CodeCategoryNameSeverityAuto ResolveInternal Usage
2001GeneralArticleValidationlownot implementedValidate
2002CartStatuslownot implementedValidate
2003CartItemPresencelownot implementedValidate
2004UserAssignmentStatuslownot implementedValidate
2005PriceValidationlownot implementedValidate
2006RegistrationActiveStatuslownot implementedValidate
2007SaleActiveStatuslownot implementedValidate
2008VatValidationlownot implementedValidate
2009RegistrationReminderEligibilitylownot implementedResendRegistrationReminderEmailHandler
2010RegistrationReminderOrderlownot implementedResendRegistrationReminderEmailHandler
2011RegistrationReminderStatuslownot implementedResendRegistrationReminderEmailHandler
2012RegistrationReminderOwnershiplownot implementedResendRegistrationReminderEmailHandler
2013ValidatorStatuslownot implementedValidateCartHandler
2015CartAmountStatuslownot implementedValidate
2016CartLegitimationStatuslownot implementedValidate
2017CartPaymentStatus

The payment for the cart is not allowed to be changed.
lownot implementedValidate
2019ItemArticleGroupContingentAssignmentlowavailableValidate
2020ItemTimeslotBookingStatuslownot implementedValidate
2021ItemTimeslotBookingLimitlownot implementedValidate
2022ItemBookedTimeslotAvailabilitylownot implementedValidate
2023RegistrationReminderPaymentlownot implementedResendRegistrationReminderEmailHandler
2024ItemTicketAttributeContingentStatuslownot implementedValidate
2101BuyerBillingValidationlownot implementedValidate
2102BuyerValidationlownot implementedValidate
2103BuyerPresencelownot implementedValidate
2201RegistrationArticlePromotionTimespanlownot implementedValidate
2203SurveyItemSelfRegistrationlownot implementedValidate
2204ItemRegistrationTypeStatuslownot implementedValidateCartItemRegistrationHandler
2205ItemRegistrationRequirementlownot implementedValidateCartItemRegistrationHandler
2206ItemReservationStatuslownot implementedValidate
2207RegistrationForItemStatuslownot implementedValidateCartItemRegistrationHandler
2208RegistrationResponseValidationlownot implementedValidateCartItemRegistrationHandler
2209RegistrationTypeLookuplownot implementedValidateCartItemRegistrationHandler
2210PrefilledRegistrationAnswersStatuslownot implementedValidateCartItemRegistrationHandler
2211SurveyAnswersConsistencylownot implementedValidate
2212TicketOwnerPersonMatchlownot implementedTicketOwnerUniquenessValidator
2213TicketOwnerUsageStatuslownot implementedTicketOwnerUniquenessValidator
2301PaymentPaymentAmountValidationlownot implementedValidate
2302PaymentExpirationStatuslownot implementedValidate
2303PaymentAssignmentStatuslownot implementedValidate
2401LimitAttendeeTicketLimitStatuslownot implementedValidate
2402ArticleLimitStatuslownot implementedValidate
2403ArticleAssortmentLimitStatuslownot implementedValidate
2404ArticleGroupLimitStatuslownot implementedValidate
2405AttendeeTicketDaysLimitLOWnot implementedValidate
2406CartItemTicketDaysLimitLoWnot implementedValidateCartItemRegistrationHandler
2407AttendeePermanentTicketStatusLoWnot implementedValidate
2408CartItemPermanentTicketStatusLoWnot implementedValidateCartItemRegistrationHandler
2409CartItemTicketLimitStatusLoWnot implementedValidateCartItemRegistrationHandler
2501LegitimationLegitimationCountryEligibilitylownot implementedValidate
2502LegitimationProofsStatuslownot implementedValidate
2503LegitimationUploadFormatlownot implementedValidate
26xxSurveyPlaceholder for survery validation resultslownot 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.

CodeCategoryNameSeverityInternal Usage
3001GeneralArticleOrderStatus

The information for processing the ticket order is missing. This includes the information regarding the ordering process like shipping information.
lowAddItem
3002ArticleTicketAvailabilitylowAddItem
3003ArticleLookuplowAddItem
3004ArticleEventAssignmentlowAddItem
3005ArticleForCartValidationlowAddItem
3006ArticleQuantityValidationlowAddItem
3007SurveyReferencelowUpdateItemRegistration
3008ItemLookuplowUpdateItemRegistration
3009RegistrationTypeAvailabilitylowUpdateItemRegistration
3010RegistrationConfigurationLookup

The registration configuration contains the information whether the ticket registration is required and/or possible as well as the ticket registration type.
lowPersonRegistrationService
3011RegistrationInformationLookup

The ticket registration is required but the item is missing the survey information.
lowPersonRegistrationService
3012RegistrationSurveyLookuplowPersonRegistrationService
3013RegistrationSurveyBindlowPersonRegistrationService
3014ArticleReservationlowAddItem
3015CartAssortmentStatuslowExclusiveAssortmentGuard
3016RecommendationItemslowApplyRecommendations
3101LimitArticleLimitlowAddCoupon,AddItem
3102ArticleLimitPerAttendeelowAddCoupon,AddItem
3103ArticleAssortmentLimitlowAddItem
3104ArticleGroupLimitlowAddItem
3105ArticleVoucherLimitlowAddCoupon
3106ArticleGroupContingentlowAddItem
3107ArticleMinimumLimitlowAddItem
3108CartVoucherLimitlowAddCoupon
3201VoucherTicketCodeRegistrationStatuslowRegistrationResult
3202AlreadyReservedTicketCodelowRegistrationResult
3203EmptyTicketPoollowRegistrationResult
3204InvalidRegistrationDatalowRegistrationResult
3205LockedTicketCode

The voucher code has been blocked.
lowRegistrationResult
3206TicketAlreadyInCartlowRegistrationResult
3207TicketCanceledlowRegistrationResult
3208TicketCodeForAnotherFaireventlowRegistrationResult
3209TicketCodeUsedUplowRegistrationResult
3210TicketOwnerLacksValidLegitimationlowRegistrationResult
3211UnkownTicketCodelowRegistrationResult
3212VoucherOwnershiplowAddCoupon
3213WrongReservationGUIDlowRegistrationResult
3301PromotionCodeGroup for Promotion Codes responses. Will be added laterlow
3401LegitimationLegitimationProofTypeStatuslowAddLegitimationHandler
3501RegistrationRegistrationValidationLOWUpdateItemRegistrationHandler
3601TimeslotsTimeslotsBookingDayRequestLOWSetCartItemTimeslotsHandler

ShopTimeslotService
3602TimeslotsBookingItemAvailabilityLOW
3603TimeslotsBookingDayExistenceLOW
3604TimeslotsBookingTimeRangeExistenceLOW
3605TimeslotsBookingTimeRangeRequirementLOW
3606TimeslotsBookingDayRequirementLOW
3607TimeslotsBookingDaysRequestedLOW
3608TimeslotsBookingDaysLimitLOW
3609TimeslotsBookingDayAvailabilityLOW
3610TimeslotsBookingTimeRangeAvailabilityLOW
3611TimeslotsBookingUniqueDayAndTimeResultLOW

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.

CodeCategoryNameSeverityInternal Usage
4001GeneralExpressCartDatamediumInitializeExpressPayment
4002CartPaymentAssignmentStatusResultmediumRemovePaymentProvider
4003PaymentInitializationmediumInitializeExpressPayment
4006PaymentStatusmediumSetPaymentProvider
4007PaymentProviderLookupmediumSetPaymentProvider

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.

CodeNameSeverityInternal Usage
5001GeneralCheckoutSaleAssignmenthighCheckout
5003CheckoutConfirmationMailhighCheckout
5004CheckoutSaleStatushighCheckout
5005CheckoutCartSaleStatushighCheckout
5006CheckoutBuyerDataStorehighCheckout
5007CheckoutSaleActionshighCheckout
5008CheckoutBuyerDatahighCheckout
5009CheckoutSaleBinariesAssignmenthighCheckout
5101PaymentCheckoutPaymentCapturehighCheckout
5102CheckoutPaymentCaptureStatushighCheckout
5103CheckoutPaymentReservationhighCheckout
5104CheckoutPaymentReservationStatushighCheckout
5201RegistrationCheckoutPromotionCodeRedemptionhighCheckout
5202CheckoutTicketRegistrationhighCheckout
5203CheckoutTicketSaleAttachmenthighCheckout
5204CheckoutTicketRegistrationStatushighCheckout
5301LegitimationCheckoutLegitimationPersonAssignmenthighCreateLegitimationsFilter

Social events messages

The social event area concerns all actions, regarding all social interactions with the shop api.

CodeNameSeverityInternal Usage
6001GeneralSocialEventValidationlowCreateSocialEvent
6002SocialEventSaleValidationlow
6003SocialEventPersonValidationlow
6004SocialEventUserValidationlow
6005SocialEventUserProfileValidationlow
6006SocialEventNetworkValidationlow
6007SocialEventContentStatuslow
6100SocialCardsSocialCardConfigurationStatusMEDIUMCreateSocialCard
6101SocialCardApiKeyValidationHigh
6102SocialCardUserPersonAssignmentlow
6103SocialCardUserProfilePictureStatuslow
6104SocialCardUserEventStatuslow
6110SocialCardLookuplowGetSocialCard
6200SharesSharingStatusHighShare
6201SharingTokenPresenceMEDIUM
6202SharingTokenValidationMEDIUM

Byndr messages

Byndr related processes and messages.

CodeNameSeverityInternal Usage
7001GeneralQuicodeValidationlow
7002InitiatorUserLookuplow
7003TargetUserLookuplow
7004DailyConnectionStatuslow
7005EventLookuplow
7006InitiatorUserEligibilitylow

Remarks

The severity level is also used as the internal debugging levels.