| Get a PDF |
"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 PdfDocument {
/** @param {{id?:number,isReady?:boolean,name?:string,fileName?:string,type?:string,sanctionsSearchId?:number,pepSearchId?:number,validIdSearchId?:number,companyLookupSearchId?:number,dateCreated?:string,dateExpires?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the saved document */
id;
/**
* @type {boolean}
* @description Is the document ready to download */
isReady;
/**
* @type {string}
* @description The name of the saved document */
name;
/**
* @type {string}
* @description The file name (including extension) of the saved document */
fileName;
/**
* @type {string}
* @description The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.) */
type;
/**
* @type {?number}
* @description If this document is a Saved Sanctions Search, the ID of the search it relates to */
sanctionsSearchId;
/**
* @type {?number}
* @description If this document is a Saved PEP Search, the ID of the search it relates to */
pepSearchId;
/**
* @type {?number}
* @description If this document is a Saved ValidID Search, the ID of the search it relates to */
validIdSearchId;
/**
* @type {?number}
* @description If this document is a Saved CompanyLookup Search, the ID of the search it relates to */
companyLookupSearchId;
/**
* @type {string}
* @description The date the saved document was created/requested */
dateCreated;
/**
* @type {string}
* @description The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods */
dateExpires;
}
export class PdfDocumentWithData extends PdfDocument {
/** @param {{documentBytes?:string,id?:number,isReady?:boolean,name?:string,fileName?:string,type?:string,sanctionsSearchId?:number,pepSearchId?:number,validIdSearchId?:number,companyLookupSearchId?:number,dateCreated?:string,dateExpires?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The file data in a byte array */
documentBytes;
}
export class GetPdfData extends BaseResponse {
/** @param {{document?:PdfDocumentWithData,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {PdfDocumentWithData}
* @description The single document that is being returned, including the file data */
document;
}
export class GetPdfResponse {
/** @param {{data?:GetPdfData}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GetPdfData}
* @description The response data */
data;
}
export class GetPdfRequest {
/** @param {{subUserName?:string,id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the saved document is kept within a single Sub User account, specify their username here */
subUserName;
/**
* @type {number}
* @description The ID of the document to retrieve */
id;
}
export class GetPdf extends BaseRequest {
/** @param {{request?:GetPdfRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {GetPdfRequest}
* @description The request data */
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>
<GetPdf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Id>0</Id>
<SubUserName>String</SubUserName>
</Request>
</GetPdf>
</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>
<GetPdfResponse 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>
<Document>
<CompanyLookupSearchId>0</CompanyLookupSearchId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateExpires>0001-01-01T00:00:00</DateExpires>
<FileName>String</FileName>
<Id>0</Id>
<IsReady>false</IsReady>
<Name>String</Name>
<PepSearchId>0</PepSearchId>
<SanctionsSearchId>0</SanctionsSearchId>
<Type>String</Type>
<ValidIdSearchId>0</ValidIdSearchId>
<DocumentBytes>AA==</DocumentBytes>
</Document>
</Data>
</GetPdfResponse>
</soap12:Body>
</soap12:Envelope>