| Get a PDF |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetPdf extends BaseRequest
{
/**
* The request data
*/
@DataMember
@ApiMember(Description="The request data", ParameterType="body")
public GetPdfRequest request = null;
public GetPdfRequest getRequest() { return request; }
public GetPdf setRequest(GetPdfRequest value) { this.request = value; return this; }
}
@DataContract
public static class BaseRequest implements IBaseRequest
{
/**
* The authentication credentials
*/
@DataMember
@ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
public Authentication authentication = null;
public Authentication getAuthentication() { return authentication; }
public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
}
@DataContract
public static class Authentication
{
/**
* The API User ID provided by us when you signed up to use our API
*/
@DataMember
@ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public String apiUserId = null;
/**
* The API User Key provided by us when you signed up to use our API
*/
@DataMember
@ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public String apiUserKey = null;
public String getApiUserId() { return apiUserId; }
public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
public String getApiUserKey() { return apiUserKey; }
public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
}
public static class GetPdfRequest
{
/**
* If the saved document is kept within a single Sub User account, specify their username here
*/
@ApiMember(Description="If the saved document is kept within a single Sub User account, specify their username here")
public String subUserName = null;
/**
* The ID of the document to retrieve
*/
@ApiMember(Description="The ID of the document to retrieve")
public Long id = null;
public String getSubUserName() { return subUserName; }
public GetPdfRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Long getId() { return id; }
public GetPdfRequest setId(Long value) { this.id = value; return this; }
}
@DataContract
public static class GetPdfResponse
{
/**
* The response data
*/
@DataMember
@ApiMember(Description="The response data")
public GetPdfData data = null;
public GetPdfData getData() { return data; }
public GetPdfResponse setData(GetPdfData value) { this.data = value; return this; }
}
public static class GetPdfData extends BaseResponse
{
/**
* The single document that is being returned, including the file data
*/
@ApiMember(Description="The single document that is being returned, including the file data")
public PdfDocumentWithData document = null;
public PdfDocumentWithData getDocument() { return document; }
public GetPdfData setDocument(PdfDocumentWithData value) { this.document = value; return this; }
}
public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
/**
* The status of the response
*/
@ApiMember(Description="The status of the response")
public ResponseStatus responseStatus = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
public static class ArrayOfResponseError extends ArrayList<ResponseError>
{
}
public static class PdfDocumentWithData extends PdfDocument
{
/**
* The file data in a byte array
*/
@ApiMember(Description="The file data in a byte array")
public byte[] documentBytes = null;
public byte[] getDocumentBytes() { return documentBytes; }
public PdfDocumentWithData setDocumentBytes(byte[] value) { this.documentBytes = value; return this; }
}
public static class PdfDocument
{
/**
* The ID of the saved document
*/
@ApiMember(Description="The ID of the saved document")
public Long id = null;
/**
* Is the document ready to download
*/
@ApiMember(Description="Is the document ready to download")
public Boolean isReady = null;
/**
* The name of the saved document
*/
@ApiMember(Description="The name of the saved document")
public String name = null;
/**
* The file name (including extension) of the saved document
*/
@ApiMember(Description="The file name (including extension) of the saved document")
public String fileName = null;
/**
* The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
*/
@ApiMember(Description="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")
public String type = null;
/**
* If this document is a Saved Sanctions Search, the ID of the search it relates to
*/
@ApiMember(Description="If this document is a Saved Sanctions Search, the ID of the search it relates to")
public Long sanctionsSearchId = null;
/**
* If this document is a Saved PEP Search, the ID of the search it relates to
*/
@ApiMember(Description="If this document is a Saved PEP Search, the ID of the search it relates to")
public Long pepSearchId = null;
/**
* If this document is a Saved ValidID Search, the ID of the search it relates to
*/
@ApiMember(Description="If this document is a Saved ValidID Search, the ID of the search it relates to")
public Integer validIdSearchId = null;
/**
* If this document is a Saved CompanyLookup Search, the ID of the search it relates to
*/
@ApiMember(Description="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")
public Integer companyLookupSearchId = null;
/**
* The date the saved document was created/requested
*/
@ApiMember(Description="The date the saved document was created/requested")
public Date dateCreated = null;
/**
* The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods
*/
@ApiMember(Description="The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods")
public Date dateExpires = null;
public Long getId() { return id; }
public PdfDocument setId(Long value) { this.id = value; return this; }
public Boolean getIsReady() { return isReady; }
public PdfDocument setIsReady(Boolean value) { this.isReady = value; return this; }
public String getName() { return name; }
public PdfDocument setName(String value) { this.name = value; return this; }
public String getFileName() { return fileName; }
public PdfDocument setFileName(String value) { this.fileName = value; return this; }
public String getType() { return type; }
public PdfDocument setType(String value) { this.type = value; return this; }
public Long getSanctionsSearchId() { return sanctionsSearchId; }
public PdfDocument setSanctionsSearchId(Long value) { this.sanctionsSearchId = value; return this; }
public Long getPepSearchId() { return pepSearchId; }
public PdfDocument setPepSearchId(Long value) { this.pepSearchId = value; return this; }
public Integer getValidIdSearchId() { return validIdSearchId; }
public PdfDocument setValidIdSearchId(Integer value) { this.validIdSearchId = value; return this; }
public Integer getCompanyLookupSearchId() { return companyLookupSearchId; }
public PdfDocument setCompanyLookupSearchId(Integer value) { this.companyLookupSearchId = value; return this; }
public Date getDateCreated() { return dateCreated; }
public PdfDocument setDateCreated(Date value) { this.dateCreated = value; return this; }
public Date getDateExpires() { return dateExpires; }
public PdfDocument setDateExpires(Date value) { this.dateExpires = value; return this; }
}
}
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>