Sanctions Search API: v2

<back to all web services

GetPdf

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetPdf : BaseRequest()
{
    /**
    * The request data
    */
    @DataMember
    @ApiMember(Description="The request data", ParameterType="body")
    var request:GetPdfRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open 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")
    var apiUserId:String? = 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")
    var apiUserKey:String? = null
}

open 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")
    var subUserName:String? = null

    /**
    * The ID of the document to retrieve
    */
    @ApiMember(Description="The ID of the document to retrieve")
    var id:Long? = null
}

@DataContract
open class GetPdfResponse
{
    /**
    * The response data
    */
    @DataMember
    @ApiMember(Description="The response data")
    @SerializedName("data") var Data:GetPdfData? = null
}

open class GetPdfData : 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")
    var document:PdfDocumentWithData? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class PdfDocumentWithData : PdfDocument()
{
    /**
    * The file data in a byte array
    */
    @ApiMember(Description="The file data in a byte array")
    var documentBytes:ByteArray? = null
}

open class PdfDocument
{
    /**
    * The ID of the saved document
    */
    @ApiMember(Description="The ID of the saved document")
    var id:Long? = null

    /**
    * Is the document ready to download
    */
    @ApiMember(Description="Is the document ready to download")
    var isReady:Boolean? = null

    /**
    * The name of the saved document
    */
    @ApiMember(Description="The name of the saved document")
    var name:String? = null

    /**
    * The file name (including extension) of the saved document
    */
    @ApiMember(Description="The file name (including extension) of the saved document")
    var fileName:String? = 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.)")
    @SerializedName("type") var Type:String? = 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")
    var sanctionsSearchId:Long? = 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")
    var pepSearchId:Long? = 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")
    var validIdSearchId:Int? = 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")
    var companyLookupSearchId:Int? = null

    /**
    * The date the saved document was created/requested
    */
    @ApiMember(Description="The date the saved document was created/requested")
    var dateCreated:Date? = 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")
    var dateExpires:Date? = null
}

Kotlin GetPdf DTOs

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>