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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Autoboarding.Common.Requests;
using Autoboarding.Common.Responses;
using Autoboarding.Common;

namespace Autoboarding.Common
{
    [DataContract]
    public enum ApplicationBoardingStatus
    {
        PENDING = 0,
        IN_PROGRESS = 5,
        FAILED = 9,
        COMPLETED = 10,
    }

    [DataContract]
    public 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,
    }

}

namespace Autoboarding.Common.Requests
{
    public partial class RetrieveBoardingResultRequest
    {
        public virtual Guid AppQueueGuid { get; set; }
    }

}

namespace Autoboarding.Common.Responses
{
    public partial class RetrieveBoardingResultResponse
    {
        public RetrieveBoardingResultResponse()
        {
            ErrorMessages = new List<string>{};
            PartyIndividuals = new List<string>{};
        }

        public virtual Guid? AppQueueGUID { get; set; }
        public virtual string ApplicationId { get; set; }
        public virtual string CSR { get; set; }
        public virtual string PartyID { get; set; }
        public virtual bool Autoboarded { get; set; }
        public virtual ApplicationQueueStatus QueueStatus { get; set; }
        public virtual ApplicationBoardingStatus? BoardingStatus { get; set; }
        public virtual List<string> ErrorMessages { get; set; }
        public virtual string OrderId { get; set; }
        public virtual string LEID { get; set; }
        public virtual List<string> PartyIndividuals { get; set; }
    }

}

C# 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-featuretest.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>