| Get all the ValidID Searches |
"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 ValidIdSearchCriteria {
/** @param {{fullName?:string,dateOfBirth?:string,gender?:string,address?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
fullName;
/** @type {string} */
dateOfBirth;
/** @type {string} */
gender;
/** @type {string} */
address;
}
export class ValidIdListItem {
/** @param {{id?:number,type?:number,score?:number,status?:string,dateSearched?:string,reference?:string,pepError?:boolean,replaced?:boolean,replacementSearchId?:number,hasCompletedRequest?:boolean,hasCompletedSearch?:boolean,searchCriteria?:ValidIdSearchCriteria}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
type;
/** @type {?number} */
score;
/** @type {string} */
status;
/** @type {string} */
dateSearched;
/** @type {string} */
reference;
/** @type {boolean} */
pepError;
/** @type {boolean} */
replaced;
/** @type {?number} */
replacementSearchId;
/** @type {boolean} */
hasCompletedRequest;
/** @type {boolean} */
hasCompletedSearch;
/** @type {ValidIdSearchCriteria} */
searchCriteria;
}
export class ArrayOfValidIdListItem extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetValidIdsData extends BaseResponse {
/** @param {{totalSearchRecords?:number,currentPageNum?:number,maxPageNum?:number,searchRecords?:ArrayOfValidIdListItem,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
totalSearchRecords;
/** @type {number} */
currentPageNum;
/** @type {number} */
maxPageNum;
/** @type {ArrayOfValidIdListItem} */
searchRecords;
}
export class GetValidIdsResponse {
/** @param {{data?:GetValidIdsData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetValidIdsData} */
data;
}
export class GetValidIdsRequest {
/** @param {{subUserName?:string,page?:number,sortOrder?:string,nameSearch?:string,filterReference?:string,filterType?:string,filterDateFrom?:string,filterDateTo?:string,filterUserName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view */
subUserName;
/** @type {number} */
page;
/** @type {string} */
sortOrder;
/** @type {string} */
nameSearch;
/** @type {string} */
filterReference;
/** @type {string} */
filterType;
/** @type {?string} */
filterDateFrom;
/** @type {?string} */
filterDateTo;
/**
* @type {string}
* @description If set, will only return searches created by the user */
filterUserName;
}
export class GetValidIds extends BaseRequest {
/** @param {{request?:GetValidIdsRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {GetValidIdsRequest} */
request;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetValidIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterReference>String</FilterReference>
<FilterType>String</FilterType>
<FilterUserName>String</FilterUserName>
<NameSearch>String</NameSearch>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetValidIds>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetValidIdsResponse 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>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<SearchRecords>
<SearchRecord>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<HasCompletedRequest>false</HasCompletedRequest>
<HasCompletedSearch>false</HasCompletedSearch>
<Id>0</Id>
<PepError>false</PepError>
<Reference>String</Reference>
<Replaced>false</Replaced>
<ReplacementSearchId>0</ReplacementSearchId>
<Score>0</Score>
<SearchCriteria>
<Address>String</Address>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<FullName>String</FullName>
<Gender>String</Gender>
</SearchCriteria>
<Status>String</Status>
<Type>0</Type>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetValidIdsResponse>
</soap12:Body>
</soap12:Envelope>