| POST | /pdfs/list | Get all PDFs |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetPdfs extends BaseRequest
{
/**
* The request data
*/
@DataMember
@ApiMember(Description="The request data", ParameterType="body")
public GetPdfsRequest request = null;
public GetPdfsRequest getRequest() { return request; }
public GetPdfs setRequest(GetPdfsRequest 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 GetPdfsRequest
{
/**
* If the saved documents are kept within a single Sub User account, specify their username here
*/
@ApiMember(Description="If the saved documents are kept within a single Sub User account, specify their username here")
public String subUserName = null;
public String getSubUserName() { return subUserName; }
public GetPdfsRequest setSubUserName(String value) { this.subUserName = value; return this; }
}
@DataContract
public static class GetPdfsResponse
{
/**
* The response data
*/
@DataMember
@ApiMember(Description="The response data")
public GetPdfsData data = null;
public GetPdfsData getData() { return data; }
public GetPdfsResponse setData(GetPdfsData value) { this.data = value; return this; }
}
public static class GetPdfsData extends BaseResponse
{
/**
* List of Documents, but not including the file data
*/
@ApiMember(Description="List of Documents, but not including the file data")
public ArrayOfPdfDocument documents = null;
public ArrayOfPdfDocument getDocuments() { return documents; }
public GetPdfsData setDocuments(ArrayOfPdfDocument value) { this.documents = 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 ArrayOfPdfDocument extends ArrayList<PdfDocument>
{
}
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /pdfs/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"documents":[{"id":0,"isReady":false,"name":"String","fileName":"String","type":"String","sanctionsSearchId":0,"pepSearchId":0,"validIdSearchId":0,"companyLookupSearchId":0,"dateCreated":"\/Date(-62135596800000-0000)\/","dateExpires":"\/Date(-62135596800000-0000)\/"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}