| 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 .xml suffix or ?format=xml
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.worldpay.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<InitiateBoardingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Requests">
<ApplicationSource>0</ApplicationSource>
<CSR>0</CSR>
<EncryptedXML>String</EncryptedXML>
<GUID>00000000-0000-0000-0000-000000000000</GUID>
<SalesmanEmail>String</SalesmanEmail>
<SalesmanID>String</SalesmanID>
</InitiateBoardingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InitiateBoardingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Responses">
<ApplicationGuid>00000000-0000-0000-0000-000000000000</ApplicationGuid>
<ApplicationQueueGuid>00000000-0000-0000-0000-000000000000</ApplicationQueueGuid>
<BoardingStatus>PENDING</BoardingStatus>
<CSR>0</CSR>
<ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ErrorMessages>
<QueueStatus>Queued</QueueStatus>
</InitiateBoardingResponse>