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.*;

public class dtos
{

    public static class RetrieveBoardingResultRequest
    {
        public UUID appQueueGuid = null;
        
        public UUID getAppQueueGuid() { return appQueueGuid; }
        public RetrieveBoardingResultRequest setAppQueueGuid(UUID value) { this.appQueueGuid = value; return this; }
    }

    public static class RetrieveBoardingResultResponse
    {
        public UUID appQueueGUID = null;
        public String applicationId = null;
        public String csr = null;
        public String partyID = null;
        public Boolean autoboarded = null;
        public ApplicationQueueStatus queueStatus = null;
        public ApplicationBoardingStatus boardingStatus = null;
        public ArrayList<String> errorMessages = null;
        public String orderId = null;
        public String leid = null;
        public ArrayList<String> partyIndividuals = null;
        
        public UUID getAppQueueGUID() { return appQueueGUID; }
        public RetrieveBoardingResultResponse setAppQueueGUID(UUID value) { this.appQueueGUID = value; return this; }
        public String getApplicationId() { return applicationId; }
        public RetrieveBoardingResultResponse setApplicationId(String value) { this.applicationId = value; return this; }
        public String getCsr() { return csr; }
        public RetrieveBoardingResultResponse setCsr(String value) { this.csr = value; return this; }
        public String getPartyID() { return partyID; }
        public RetrieveBoardingResultResponse setPartyID(String value) { this.partyID = value; return this; }
        public Boolean isAutoboarded() { return autoboarded; }
        public RetrieveBoardingResultResponse setAutoboarded(Boolean value) { this.autoboarded = value; return this; }
        public ApplicationQueueStatus getQueueStatus() { return queueStatus; }
        public RetrieveBoardingResultResponse setQueueStatus(ApplicationQueueStatus value) { this.queueStatus = value; return this; }
        public ApplicationBoardingStatus getBoardingStatus() { return boardingStatus; }
        public RetrieveBoardingResultResponse setBoardingStatus(ApplicationBoardingStatus value) { this.boardingStatus = value; return this; }
        public ArrayList<String> getErrorMessages() { return errorMessages; }
        public RetrieveBoardingResultResponse setErrorMessages(ArrayList<String> value) { this.errorMessages = value; return this; }
        public String getOrderId() { return orderId; }
        public RetrieveBoardingResultResponse setOrderId(String value) { this.orderId = value; return this; }
        public String getLeid() { return leid; }
        public RetrieveBoardingResultResponse setLeid(String value) { this.leid = value; return this; }
        public ArrayList<String> getPartyIndividuals() { return partyIndividuals; }
        public RetrieveBoardingResultResponse setPartyIndividuals(ArrayList<String> value) { this.partyIndividuals = value; return this; }
    }

    @DataContract
    public static enum ApplicationQueueStatus
    {
        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);

        private final int value;
        ApplicationQueueStatus(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    @DataContract
    public static enum ApplicationBoardingStatus
    {
        Pending(0),
        InProgress(5),
        Failed(9),
        Completed(10);

        private final int value;
        ApplicationBoardingStatus(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java 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

HTTP + JSON

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"]}