| POST | /pdfs/get | Get 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; }
}
}
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/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"document":{"documentBytes":"AA==","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"}}}}