| POST | /InitiateBoarding |
|---|
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 InitiateBoardingRequest
{
public virtual Guid GUID { get; set; }
public virtual int CSR { get; set; }
public virtual string EncryptedXML { get; set; }
public virtual string SalesmanID { get; set; }
public virtual string SalesmanEmail { get; set; }
public virtual int ApplicationSource { get; set; }
}
}
namespace Autoboarding.Common.Responses
{
public partial class InitiateBoardingResponse
{
public InitiateBoardingResponse()
{
ErrorMessages = new List<string>{};
}
public virtual Guid ApplicationGuid { get; set; }
public virtual int CSR { get; set; }
public virtual Guid? ApplicationQueueGuid { get; set; }
public virtual ApplicationQueueStatus QueueStatus { get; set; }
public virtual ApplicationBoardingStatus? BoardingStatus { get; set; }
public virtual List<string> ErrorMessages { get; set; }
}
}
C# 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-featuretest.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>