Autoboard Webservice v5.13.0.0

<back to all web services

InitiateBoardingRequest

xml-app
Requires Authentication
The following routes are available for this service:
POST/InitiateBoarding
namespace Autoboarding.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    type 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

    [<DataContract>]
    type ApplicationBoardingStatus =
        | PENDING = 0
        | IN_PROGRESS = 5
        | FAILED = 9
        | COMPLETED = 10

    [<AllowNullLiteral>]
    type InitiateBoardingResponse() = 
        member val ApplicationGuid:Guid = new Guid() with get,set
        member val CSR:Int32 = new Int32() with get,set
        member val ApplicationQueueGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val QueueStatus:ApplicationQueueStatus = new ApplicationQueueStatus() with get,set
        member val BoardingStatus:Nullable<ApplicationBoardingStatus> = new Nullable<ApplicationBoardingStatus>() with get,set
        member val ErrorMessages:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type InitiateBoardingRequest() = 
        member val GUID:Guid = new Guid() with get,set
        member val CSR:Int32 = new Int32() with get,set
        member val EncryptedXML:String = null with get,set
        member val SalesmanID:String = null with get,set
        member val SalesmanEmail:String = null with get,set
        member val ApplicationSource:Int32 = new Int32() with get,set

F# InitiateBoardingRequest 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.

POST /InitiateBoarding HTTP/1.1 
Host: abservice-test.worldpay.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"guid":"00000000000000000000000000000000","csr":0,"encryptedXML":"String","salesmanID":"String","salesmanEmail":"String","applicationSource":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"applicationGuid":"00000000000000000000000000000000","csr":0,"applicationQueueGuid":"00000000000000000000000000000000","queueStatus":"Queued","boardingStatus":"PENDING","errorMessages":["String"]}