Autoboard Webservice v5.13.0.0

InitiateBoardingRequest

xml-app

The following routes are available for this service:
POST	/InitiateBoarding

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 InitiateBoardingResponse implements IConvertible
{
    String? applicationGuid;
    int? csr;
    String? applicationQueueGuid;
    ApplicationQueueStatus? queueStatus;
    ApplicationBoardingStatus? boardingStatus;
    List<String>? errorMessages;

    InitiateBoardingResponse({this.applicationGuid,this.csr,this.applicationQueueGuid,this.queueStatus,this.boardingStatus,this.errorMessages});
    InitiateBoardingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        applicationGuid = json['applicationGuid'];
        csr = json['csr'];
        applicationQueueGuid = json['applicationQueueGuid'];
        queueStatus = JsonConverters.fromJson(json['queueStatus'],'ApplicationQueueStatus',context!);
        boardingStatus = JsonConverters.fromJson(json['boardingStatus'],'ApplicationBoardingStatus',context!);
        errorMessages = JsonConverters.fromJson(json['errorMessages'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'applicationGuid': applicationGuid,
        'csr': csr,
        'applicationQueueGuid': applicationQueueGuid,
        'queueStatus': JsonConverters.toJson(queueStatus,'ApplicationQueueStatus',context!),
        'boardingStatus': JsonConverters.toJson(boardingStatus,'ApplicationBoardingStatus',context!),
        'errorMessages': JsonConverters.toJson(errorMessages,'List<String>',context!)
    };

    getTypeName() => "InitiateBoardingResponse";
    TypeContext? context = _ctx;
}

class InitiateBoardingRequest implements IConvertible
{
    String? guid;
    int? csr;
    String? encryptedXML;
    String? salesmanID;
    String? salesmanEmail;
    int? applicationSource;

    InitiateBoardingRequest({this.guid,this.csr,this.encryptedXML,this.salesmanID,this.salesmanEmail,this.applicationSource});
    InitiateBoardingRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        guid = json['guid'];
        csr = json['csr'];
        encryptedXML = json['encryptedXML'];
        salesmanID = json['salesmanID'];
        salesmanEmail = json['salesmanEmail'];
        applicationSource = json['applicationSource'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': guid,
        'csr': csr,
        'encryptedXML': encryptedXML,
        'salesmanID': salesmanID,
        'salesmanEmail': salesmanEmail,
        'applicationSource': applicationSource
    };

    getTypeName() => "InitiateBoardingRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'abservice_featuretest.worldpay.com', types: <String, TypeInfo> {
    'ApplicationQueueStatus': TypeInfo(TypeOf.Enum, enumValues:ApplicationQueueStatus.values),
    'ApplicationBoardingStatus': TypeInfo(TypeOf.Enum, enumValues:ApplicationBoardingStatus.values),
    'InitiateBoardingResponse': TypeInfo(TypeOf.Class, create:() => InitiateBoardingResponse()),
    'InitiateBoardingRequest': TypeInfo(TypeOf.Class, create:() => InitiateBoardingRequest()),
});

Dart 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

HTTP + JSON

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/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"]}