"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API User ID provided by us when you signed up to use our API */
apiUserId;
/**
* @type {string}
* @description The API User Key provided by us when you signed up to use our API */
apiUserKey;
}
export class BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description The authentication credentials */
authentication;
}
export class ResponseError {
/** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
fieldName;
/** @type {string} */
message;
/** @type {{ [index: string]: string; }} */
meta;
}
export class ArrayOfResponseError extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
/** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
message;
/** @type {string} */
stackTrace;
/** @type {ArrayOfResponseError} */
errors;
/** @type {{ [index: string]: string; }} */
meta;
}
export class BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ResponseStatus}
* @description The status of the response */
responseStatus;
}
export class LinkedTo {
/** @param {{clientId?:number,id?:number,type?:string,subtype?:string,status?:string,description?:string,isArchived?:boolean,name?:string,date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
clientId;
/** @type {?number} */
id;
/** @type {?string} */
type;
/** @type {?string} */
subtype;
/** @type {?string} */
status;
/** @type {?string} */
description;
/** @type {?boolean} */
isArchived;
/** @type {?string} */
name;
/** @type {?string} */
date;
}
export class ArrayOfLinkedTo extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ApplicantInformation {
/** @param {{name?:string,dateOfBirth?:string,email?:string,mobileInternational?:string,jobLocation?:string,reference?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
dateOfBirth;
/** @type {string} */
email;
/** @type {string} */
mobileInternational;
/** @type {string} */
jobLocation;
/** @type {string} */
reference;
}
export class DbsSearchSummary {
/** @param {{id?:number,dateSearched?:string,dateUpdated?:string,status?:string,disclosureStatus?:string,isApplicantInfoCompleted?:boolean,isIdCheckCompleted?:boolean,isApplicationCompleted?:boolean,isApplicationSubmitted?:boolean,isApplicationDisclosed?:boolean,disclosureLevel?:string,applicantInformation?:ApplicantInformation}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
dateSearched;
/** @type {string} */
dateUpdated;
/** @type {string} */
status;
/** @type {string} */
disclosureStatus;
/** @type {boolean} */
isApplicantInfoCompleted;
/** @type {boolean} */
isIdCheckCompleted;
/** @type {boolean} */
isApplicationCompleted;
/** @type {boolean} */
isApplicationSubmitted;
/** @type {boolean} */
isApplicationDisclosed;
/** @type {string} */
disclosureLevel;
/** @type {ApplicantInformation} */
applicantInformation;
}
export class GetDbsSearchData extends BaseResponse {
/** @param {{linkedTo?:ArrayOfLinkedTo,summary?:DbsSearchSummary,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfLinkedTo} */
linkedTo;
/** @type {DbsSearchSummary} */
summary;
}
export class GetDbsSearchResponse {
/** @param {{data?:GetDbsSearchData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetDbsSearchData} */
data;
}
export class GetDbsSearch extends BaseRequest {
/** @param {{id?:number,subUserName?:string,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the DBS Search */
id;
/**
* @type {string}
* @description Provide a value to only return a search that the specified sub user has permission to access. If this is null or empty, then sub user permissions will not be enforced and the search will be returned */
subUserName;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetDbsSearch
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDbsSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Id>0</Id>
<SubUserName>String</SubUserName>
</GetDbsSearch>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDbsSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<Summary>
<ApplicantInformation>
<DateOfBirth>String</DateOfBirth>
<Email>String</Email>
<JobLocation>String</JobLocation>
<MobileInternational>String</MobileInternational>
<Name>String</Name>
<Reference>String</Reference>
</ApplicantInformation>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<DisclosureLevel>String</DisclosureLevel>
<DisclosureStatus>String</DisclosureStatus>
<Id>0</Id>
<IsApplicantInfoCompleted>false</IsApplicantInfoCompleted>
<IsApplicationCompleted>false</IsApplicationCompleted>
<IsApplicationDisclosed>false</IsApplicationDisclosed>
<IsApplicationSubmitted>false</IsApplicationSubmitted>
<IsIdCheckCompleted>false</IsIdCheckCompleted>
<Status>String</Status>
</Summary>
</Data>
</GetDbsSearchResponse>
</soap:Body>
</soap:Envelope>