| GET | /RetrieveBoardingResult |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class ApplicationQueueStatus(IntEnum):
QUEUED = 0
STANDARDISED_X_M_L = 20
READY_TO_DISTRIBUTE = 40
AWAITING_DISTRIBUTE_RESPONSE = 60
READY_TO_AUTOBOARD = 80
THROTTLE_CHECK_PASSED = 100
ELIGIBILITY_CHECK_PASSED = 300
SENT_TO_AUTOBOARD_SERVICE = 400
AUTOBOARDING_SUSPENDED = 450
SUCCESSFULLY_BOARDED = 500
QUEUE_ERROR = 1000
THROTTLE_CHECK_ERROR = 1100
XML_STANDARDISATION_ERROR = 1200
ELIGIBILITY_CHECK_ERROR = 1300
AUTOBOARDING_ERROR = 1400
INELIGIBLE_THROTTLE_LIMIT = 2100
INELIGIBLE_APPLICATION = 2300
class ApplicationBoardingStatus(IntEnum):
PENDING = 0
I_N__P_R_O_G_R_E_S_S = 5
FAILED = 9
COMPLETED = 10
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveBoardingResultResponse:
app_queue_g_u_i_d: Optional[str] = None
application_id: Optional[str] = None
csr: Optional[str] = None
party_i_d: Optional[str] = None
autoboarded: Optional[bool] = None
queue_status: Optional[ApplicationQueueStatus] = None
boarding_status: Optional[ApplicationBoardingStatus] = None
error_messages: Optional[List[str]] = None
order_id: Optional[str] = None
leid: Optional[str] = None
party_individuals: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveBoardingResultRequest:
app_queue_guid: Optional[str] = None
Python RetrieveBoardingResultRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /RetrieveBoardingResult HTTP/1.1 Host: abservice.worldpay.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"appQueueGUID":"00000000000000000000000000000000","applicationId":"String","csr":"String","partyID":"String","autoboarded":false,"queueStatus":"Queued","boardingStatus":"PENDING","errorMessages":["String"],"orderId":"String","leid":"String","partyIndividuals":["String"]}