Sanctions Search API: v2

<back to all web services

GetPdf

Account
The following routes are available for this service:
POST/pdfs/getGet a PDF
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Account;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
{
    [DataContract]
    public partial class GetPdf
        : BaseRequest
    {
        ///<summary>
        ///The request data
        ///</summary>
        [DataMember]
        [ApiMember(Description="The request data", ParameterType="body")]
        public virtual GetPdfRequest Request { get; set; }
    }

    public partial class GetPdfData
        : BaseResponse
    {
        ///<summary>
        ///The single document that is being returned, including the file data
        ///</summary>
        [ApiMember(Description="The single document that is being returned, including the file data")]
        public virtual PdfDocumentWithData Document { get; set; }
    }

    public partial class GetPdfRequest
    {
        ///<summary>
        ///If the saved document is kept within a single Sub User account, specify their username here
        ///</summary>
        [ApiMember(Description="If the saved document is kept within a single Sub User account, specify their username here")]
        public virtual string SubUserName { get; set; }

        ///<summary>
        ///The ID of the document to retrieve
        ///</summary>
        [ApiMember(Description="The ID of the document to retrieve")]
        public virtual long Id { get; set; }
    }

    [DataContract]
    public partial class GetPdfResponse
    {
        ///<summary>
        ///The response data
        ///</summary>
        [DataMember]
        [ApiMember(Description="The response data")]
        public virtual GetPdfData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }
    }

    public partial class PdfDocument
    {
        ///<summary>
        ///The ID of the saved document
        ///</summary>
        [ApiMember(Description="The ID of the saved document")]
        public virtual long Id { get; set; }

        ///<summary>
        ///Is the document ready to download
        ///</summary>
        [ApiMember(Description="Is the document ready to download")]
        public virtual bool IsReady { get; set; }

        ///<summary>
        ///The name of the saved document
        ///</summary>
        [ApiMember(Description="The name of the saved document")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The file name (including extension) of the saved document
        ///</summary>
        [ApiMember(Description="The file name (including extension) of the saved document")]
        public virtual string FileName { get; set; }

        ///<summary>
        ///The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
        ///</summary>
        [ApiMember(Description="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")]
        public virtual string Type { get; set; }

        ///<summary>
        ///If this document is a Saved Sanctions Search, the ID of the search it relates to
        ///</summary>
        [ApiMember(Description="If this document is a Saved Sanctions Search, the ID of the search it relates to")]
        public virtual long? SanctionsSearchId { get; set; }

        ///<summary>
        ///If this document is a Saved PEP Search, the ID of the search it relates to
        ///</summary>
        [ApiMember(Description="If this document is a Saved PEP Search, the ID of the search it relates to")]
        public virtual long? PepSearchId { get; set; }

        ///<summary>
        ///If this document is a Saved ValidID Search, the ID of the search it relates to
        ///</summary>
        [ApiMember(Description="If this document is a Saved ValidID Search, the ID of the search it relates to")]
        public virtual int? ValidIdSearchId { get; set; }

        ///<summary>
        ///If this document is a Saved CompanyLookup Search, the ID of the search it relates to
        ///</summary>
        [ApiMember(Description="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")]
        public virtual int? CompanyLookupSearchId { get; set; }

        ///<summary>
        ///The date the saved document was created/requested
        ///</summary>
        [ApiMember(Description="The date the saved document was created/requested")]
        public virtual DateTime DateCreated { get; set; }

        ///<summary>
        ///The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods
        ///</summary>
        [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 virtual DateTime DateExpires { get; set; }
    }

    public partial class PdfDocumentWithData
        : PdfDocument
    {
        public PdfDocumentWithData()
        {
            DocumentBytes = new byte[]{};
        }

        ///<summary>
        ///The file data in a byte array
        ///</summary>
        [ApiMember(Description="The file data in a byte array")]
        public virtual byte[] DocumentBytes { get; set; }
    }

}

C# GetPdf DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /pdfs/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<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>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<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>