GET | /RetrieveBoardingResult |
---|
import Foundation
import ServiceStack
public class RetrieveBoardingResultRequest : Codable
{
public var appQueueGuid:String?
required public init(){}
}
public class RetrieveBoardingResultResponse : Codable
{
public var appQueueGUID:String?
public var applicationId:String?
public var csr:String?
public var partyID:String?
public var autoboarded:Bool?
public var queueStatus:ApplicationQueueStatus?
public var boardingStatus:ApplicationBoardingStatus?
public var errorMessages:[String] = []
public var orderId:String?
public var leid:String?
public var partyIndividuals:[String] = []
required public init(){}
}
// @DataContract
public enum ApplicationQueueStatus : Int, Codable
{
case Queued = 0
case StandardisedXML = 20
case ReadyToDistribute = 40
case AwaitingDistributeResponse = 60
case ReadyToAutoboard = 80
case ThrottleCheckPassed = 100
case EligibilityCheckPassed = 300
case SentToAutoboardService = 400
case AutoboardingSuspended = 450
case SuccessfullyBoarded = 500
case QueueError = 1000
case ThrottleCheckError = 1100
case XMLStandardisationError = 1200
case EligibilityCheckError = 1300
case AutoboardingError = 1400
case IneligibleThrottleLimit = 2100
case IneligibleApplication = 2300
}
// @DataContract
public enum ApplicationBoardingStatus : Int, Codable
{
case PENDING = 0
case IN_PROGRESS = 5
case FAILED = 9
case COMPLETED = 10
}
Swift 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-test.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"]}