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

Namespace Global

    Namespace Autoboarding.Common

        <DataContract>
        Public Enum ApplicationBoardingStatus
            PENDING = 0
            IN_PROGRESS = 5
            FAILED = 9
            COMPLETED = 10
        End Enum

        <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
        End Enum
    End Namespace

    Namespace Autoboarding.Common.Requests

        Public Partial Class RetrieveBoardingResultRequest
            Public Overridable Property AppQueueGuid As Guid
        End Class
    End Namespace

    Namespace Autoboarding.Common.Responses

        Public Partial Class RetrieveBoardingResultResponse
            Public Sub New()
                ErrorMessages = New List(Of String)
                PartyIndividuals = New List(Of String)
            End Sub

            Public Overridable Property AppQueueGUID As Nullable(Of Guid)
            Public Overridable Property ApplicationId As String
            Public Overridable Property CSR As String
            Public Overridable Property PartyID As String
            Public Overridable Property Autoboarded As Boolean
            Public Overridable Property QueueStatus As ApplicationQueueStatus
            Public Overridable Property BoardingStatus As Nullable(Of ApplicationBoardingStatus)
            Public Overridable Property ErrorMessages As List(Of String)
            Public Overridable Property OrderId As String
            Public Overridable Property LEID As String
            Public Overridable Property PartyIndividuals As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET 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"]}