Autoboard Webservice v5.13.0.0

<back to all web services

RetrieveBoardingResultRequest

json-appxml-appjson-order
Requires Authentication
The following routes are available for this service:
GET/RetrieveBoardingResult
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RetrieveBoardingResultRequest
{
    var appQueueGuid:UUID? = null
}

open class RetrieveBoardingResultResponse
{
    var appQueueGUID:UUID? = null
    var applicationId:String? = null
    var csr:String? = null
    var partyID:String? = null
    var autoboarded:Boolean? = null
    var queueStatus:ApplicationQueueStatus? = null
    var boardingStatus:ApplicationBoardingStatus? = null
    var errorMessages:ArrayList<String> = ArrayList<String>()
    var orderId:String? = null
    var leid:String? = null
    var partyIndividuals:ArrayList<String> = ArrayList<String>()
}

@DataContract
enum class ApplicationQueueStatus(val value:Int)
{
    Queued(0),
    StandardisedXML(20),
    ReadyToDistribute(40),
    AwaitingDistributeResponse(60),
    ReadyToAutoboard(80),
    ThrottleCheckPassed(100),
    EligibilityCheckPassed(300),
    SentToAutoboardService(400),
    AutoboardingSuspended(450),
    SuccessfullyBoarded(500),
    QueueError(1000),
    ThrottleCheckError(1100),
    XmlStandardisationError(1200),
    EligibilityCheckError(1300),
    AutoboardingError(1400),
    IneligibleThrottleLimit(2100),
    IneligibleApplication(2300),
}

@DataContract
enum class ApplicationBoardingStatus(val value:Int)
{
    Pending(0),
    InProgress(5),
    Failed(9),
    Completed(10),
}

Kotlin RetrieveBoardingResultRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RetrieveBoardingResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Responses">
  <AppQueueGUID>00000000-0000-0000-0000-000000000000</AppQueueGUID>
  <ApplicationId>String</ApplicationId>
  <Autoboarded>false</Autoboarded>
  <BoardingStatus>PENDING</BoardingStatus>
  <CSR>String</CSR>
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <LEID>String</LEID>
  <OrderId>String</OrderId>
  <PartyID>String</PartyID>
  <PartyIndividuals xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartyIndividuals>
  <QueueStatus>Queued</QueueStatus>
</RetrieveBoardingResultResponse>