POST | /InitiateBoarding |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class InitiateBoardingRequest
{
public UUID guid = null;
public Integer csr = null;
public String encryptedXML = null;
public String salesmanID = null;
public String salesmanEmail = null;
public Integer applicationSource = null;
public UUID getGuid() { return guid; }
public InitiateBoardingRequest setGuid(UUID value) { this.guid = value; return this; }
public Integer getCsr() { return csr; }
public InitiateBoardingRequest setCsr(Integer value) { this.csr = value; return this; }
public String getEncryptedXML() { return encryptedXML; }
public InitiateBoardingRequest setEncryptedXML(String value) { this.encryptedXML = value; return this; }
public String getSalesmanID() { return salesmanID; }
public InitiateBoardingRequest setSalesmanID(String value) { this.salesmanID = value; return this; }
public String getSalesmanEmail() { return salesmanEmail; }
public InitiateBoardingRequest setSalesmanEmail(String value) { this.salesmanEmail = value; return this; }
public Integer getApplicationSource() { return applicationSource; }
public InitiateBoardingRequest setApplicationSource(Integer value) { this.applicationSource = value; return this; }
}
public static class InitiateBoardingResponse
{
public UUID applicationGuid = null;
public Integer csr = null;
public UUID applicationQueueGuid = null;
public ApplicationQueueStatus queueStatus = null;
public ApplicationBoardingStatus boardingStatus = null;
public ArrayList<String> errorMessages = null;
public UUID getApplicationGuid() { return applicationGuid; }
public InitiateBoardingResponse setApplicationGuid(UUID value) { this.applicationGuid = value; return this; }
public Integer getCsr() { return csr; }
public InitiateBoardingResponse setCsr(Integer value) { this.csr = value; return this; }
public UUID getApplicationQueueGuid() { return applicationQueueGuid; }
public InitiateBoardingResponse setApplicationQueueGuid(UUID value) { this.applicationQueueGuid = value; return this; }
public ApplicationQueueStatus getQueueStatus() { return queueStatus; }
public InitiateBoardingResponse setQueueStatus(ApplicationQueueStatus value) { this.queueStatus = value; return this; }
public ApplicationBoardingStatus getBoardingStatus() { return boardingStatus; }
public InitiateBoardingResponse setBoardingStatus(ApplicationBoardingStatus value) { this.boardingStatus = value; return this; }
public ArrayList<String> getErrorMessages() { return errorMessages; }
public InitiateBoardingResponse setErrorMessages(ArrayList<String> value) { this.errorMessages = value; return this; }
}
@DataContract
public static 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);
private final int value;
ApplicationQueueStatus(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract
public static enum ApplicationBoardingStatus
{
Pending(0),
InProgress(5),
Failed(9),
Completed(10);
private final int value;
ApplicationBoardingStatus(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
}
Java 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-test.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>