| GET | /RetrieveBoardingResult |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
enum ApplicationQueueStatus
{
Queued,
StandardisedXML,
ReadyToDistribute,
AwaitingDistributeResponse,
ReadyToAutoboard,
ThrottleCheckPassed,
EligibilityCheckPassed,
SentToAutoboardService,
AutoboardingSuspended,
SuccessfullyBoarded,
QueueError,
ThrottleCheckError,
XMLStandardisationError,
EligibilityCheckError,
AutoboardingError,
IneligibleThrottleLimit,
IneligibleApplication,
}
// @DataContract
enum ApplicationBoardingStatus
{
PENDING,
IN_PROGRESS,
FAILED,
COMPLETED,
}
class RetrieveBoardingResultResponse implements IConvertible
{
String? appQueueGUID;
String? applicationId;
String? csr;
String? partyID;
bool? autoboarded;
ApplicationQueueStatus? queueStatus;
ApplicationBoardingStatus? boardingStatus;
List<String>? errorMessages;
String? orderId;
String? leid;
List<String>? partyIndividuals;
RetrieveBoardingResultResponse({this.appQueueGUID,this.applicationId,this.csr,this.partyID,this.autoboarded,this.queueStatus,this.boardingStatus,this.errorMessages,this.orderId,this.leid,this.partyIndividuals});
RetrieveBoardingResultResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
appQueueGUID = json['appQueueGUID'];
applicationId = json['applicationId'];
csr = json['csr'];
partyID = json['partyID'];
autoboarded = json['autoboarded'];
queueStatus = JsonConverters.fromJson(json['queueStatus'],'ApplicationQueueStatus',context!);
boardingStatus = JsonConverters.fromJson(json['boardingStatus'],'ApplicationBoardingStatus',context!);
errorMessages = JsonConverters.fromJson(json['errorMessages'],'List<String>',context!);
orderId = json['orderId'];
leid = json['leid'];
partyIndividuals = JsonConverters.fromJson(json['partyIndividuals'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'appQueueGUID': appQueueGUID,
'applicationId': applicationId,
'csr': csr,
'partyID': partyID,
'autoboarded': autoboarded,
'queueStatus': JsonConverters.toJson(queueStatus,'ApplicationQueueStatus',context!),
'boardingStatus': JsonConverters.toJson(boardingStatus,'ApplicationBoardingStatus',context!),
'errorMessages': JsonConverters.toJson(errorMessages,'List<String>',context!),
'orderId': orderId,
'leid': leid,
'partyIndividuals': JsonConverters.toJson(partyIndividuals,'List<String>',context!)
};
getTypeName() => "RetrieveBoardingResultResponse";
TypeContext? context = _ctx;
}
class RetrieveBoardingResultRequest implements IConvertible
{
String? appQueueGuid;
RetrieveBoardingResultRequest({this.appQueueGuid});
RetrieveBoardingResultRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
appQueueGuid = json['appQueueGuid'];
return this;
}
Map<String, dynamic> toJson() => {
'appQueueGuid': appQueueGuid
};
getTypeName() => "RetrieveBoardingResultRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'abservice_test.worldpay.com', types: <String, TypeInfo> {
'ApplicationQueueStatus': TypeInfo(TypeOf.Enum, enumValues:ApplicationQueueStatus.values),
'ApplicationBoardingStatus': TypeInfo(TypeOf.Enum, enumValues:ApplicationBoardingStatus.values),
'RetrieveBoardingResultResponse': TypeInfo(TypeOf.Class, create:() => RetrieveBoardingResultResponse()),
'RetrieveBoardingResultRequest': TypeInfo(TypeOf.Class, create:() => RetrieveBoardingResultRequest()),
});
Dart RetrieveBoardingResultRequest 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.
GET /RetrieveBoardingResult HTTP/1.1 Host: abservice-test.worldpay.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RetrieveBoardingResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Autoboarding.Common.Responses">
<AppQueueGUID>00000000-0000-0000-0000-000000000000</AppQueueGUID>
<ApplicationId>String</ApplicationId>
<Autoboarded>false</Autoboarded>
<BoardingStatus>PENDING</BoardingStatus>
<CSR>String</CSR>
<ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ErrorMessages>
<LEID>String</LEID>
<OrderId>String</OrderId>
<PartyID>String</PartyID>
<PartyIndividuals xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PartyIndividuals>
<QueueStatus>Queued</QueueStatus>
</RetrieveBoardingResultResponse>