| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"]}