POST | /InitiateBoarding |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class InitiateBoardingRequest
{
var guid:UUID? = null
var csr:Int? = null
var encryptedXML:String? = null
var salesmanID:String? = null
var salesmanEmail:String? = null
var applicationSource:Int? = null
}
open class InitiateBoardingResponse
{
var applicationGuid:UUID? = null
var csr:Int? = null
var applicationQueueGuid:UUID? = null
var queueStatus:ApplicationQueueStatus? = null
var boardingStatus:ApplicationBoardingStatus? = null
var errorMessages:ArrayList<String> = ArrayList<String>()
}
@DataContract
enum class ApplicationQueueStatus(val value:Int)
{
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
enum class ApplicationBoardingStatus(val value:Int)
{
Pending(0),
InProgress(5),
Failed(9),
Completed(10),
}
Kotlin 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>