Worldspace Document Transfer Web Service v1.40.0.0

<back to all web services

ApplicationDataRequest

Requires Authentication
The following routes are available for this service:
GET/./Application
ApplicationDataRequest Parameters:
NameParameterData TypeRequiredDescription
ApplicationGuidqueryGuidNo
AppData Parameters:
NameParameterData TypeRequiredDescription
ApplicationGUIDformGuidNo
ApplicationCSRformint?No
ProcessedApp_SalesIDformstringNo
ProcessedApp_SalesmanEmailformstringNo
ProcessedApp_Statusformint?No
ProcessedApp_DateTimeProcessedformDateTime?No
ProcessedApp_DateTimeRetrievedformDateTime?No
ProcessedApp_DateTimeCompletedformDateTime?No
ProcessedApp_CustomersEmailformstringNo
ApplicationDocumentsformList<ApplicationDocumentInfo>No
PrincipalIdentityDocumentsformList<PrincipalIdDocumentInfo>No
BoardingRouteformBoardingRouteNo
SupportingDocumentsformList<SupportingDocumentInfo>No
ApplicationXMLformstringNo
AcceptedDateTimeformDateTime?No
LicenseAttestationCompletedformboolNo
ApplicationDocumentInfo Parameters:
NameParameterData TypeRequiredDescription
Document_GUIDformGuidNo
Document_NameformstringNo
Document_DescriptionformstringNo
PrincipalIdDocumentInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FileNameformstringNo
PersonIdformintNo
PersonFullNameformstringNo
PrincipalNumberformintNo
IdentityDocumentIDformstringNo
StatusformstringNo
BoardingRoute Parameters:
NameParameterData TypeRequiredDescription
RouteToBoardingformRouteNo
MCCCodeformstringNo
MCCDescriptionformstringNo
MCCCustomerProvidedInfoformstringNo
RecruitmentClassificationformstringNo
Route Enum:
DirectToBoarding
ViaSSH
SupportingDocumentInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ProofTypeIdformintNo
ProofTypeNameformstringNo

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.

GET /./Application HTTP/1.1 
Host: apply-online-ws-test.worldpay.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ApplicationGUID":"00000000000000000000000000000000","ApplicationCSR":0,"ProcessedApp_SalesID":"String","ProcessedApp_SalesmanEmail":"String","ProcessedApp_Status":0,"ProcessedApp_DateTimeProcessed":"0001-01-01T00:00:00.0000000","ProcessedApp_DateTimeRetrieved":"0001-01-01T00:00:00.0000000","ProcessedApp_DateTimeCompleted":"0001-01-01T00:00:00.0000000","ProcessedApp_CustomersEmail":"String","ApplicationDocuments":[{"Document_GUID":"00000000000000000000000000000000","Document_Name":"String","Document_Description":"String"}],"PrincipalIdentityDocuments":[{"Id":0,"FileName":"String","PersonId":0,"PersonFullName":"String","PrincipalNumber":0,"IdentityDocumentID":"String","Status":"String"}],"BoardingRoute":{"RouteToBoarding":"DirectToBoarding","MCCCode":"String","MCCDescription":"String","MCCCustomerProvidedInfo":"String","RecruitmentClassification":"String"},"SupportingDocuments":[{"Id":0,"ProofTypeId":0,"ProofTypeName":"String"}],"ApplicationXML":"String","AcceptedDateTime":"0001-01-01T00:00:00.0000000","LicenseAttestationCompleted":false}