| POST | /pdfs/get | Get a PDF |
|---|
namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ResponseError() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val FieldName:String = null with get,set
[<DataMember(Order=3)>]
member val Message:String = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type ArrayOfResponseError() =
inherit ResizeArray<ResponseError>()
[<DataContract>]
[<AllowNullLiteral>]
type ResponseStatus() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val Message:String = null with get,set
[<DataMember(Order=3)>]
member val StackTrace:String = null with get,set
[<DataMember(Order=4)>]
member val Errors:ArrayOfResponseError = null with get,set
[<DataMember(Order=5)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///The status of the response
///</summary>
[<ApiMember(Description="The status of the response")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type PdfDocument() =
///<summary>
///The ID of the saved document
///</summary>
[<ApiMember(Description="The ID of the saved document")>]
member val Id:Int64 = new Int64() with get,set
///<summary>
///Is the document ready to download
///</summary>
[<ApiMember(Description="Is the document ready to download")>]
member val IsReady:Boolean = new Boolean() with get,set
///<summary>
///The name of the saved document
///</summary>
[<ApiMember(Description="The name of the saved document")>]
member val Name:String = null with get,set
///<summary>
///The file name (including extension) of the saved document
///</summary>
[<ApiMember(Description="The file name (including extension) of the saved document")>]
member val FileName:String = null with 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.)")>]
member val Type:String = null with 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")>]
member val SanctionsSearchId:Nullable<Int64> = new Nullable<Int64>() with 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")>]
member val PepSearchId:Nullable<Int64> = new Nullable<Int64>() with 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")>]
member val ValidIdSearchId:Nullable<Int32> = new Nullable<Int32>() with 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")>]
member val CompanyLookupSearchId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The date the saved document was created/requested
///</summary>
[<ApiMember(Description="The date the saved document was created/requested")>]
member val DateCreated:DateTime = new DateTime() with 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")>]
member val DateExpires:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type PdfDocumentWithData() =
inherit PdfDocument()
///<summary>
///The file data in a byte array
///</summary>
[<ApiMember(Description="The file data in a byte array")>]
member val DocumentBytes:Byte[] = [||] with get,set
[<AllowNullLiteral>]
type GetPdfData() =
inherit 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")>]
member val Document:PdfDocumentWithData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetPdfResponse() =
///<summary>
///The response data
///</summary>
[<DataMember>]
[<ApiMember(Description="The response data")>]
member val Data:GetPdfData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiUserId:String = null with 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")>]
member val ApiUserKey:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///The authentication credentials
///</summary>
[<DataMember>]
[<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
member val Authentication:Authentication = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val SubUserName:String = null with get,set
///<summary>
///The ID of the document to retrieve
///</summary>
[<ApiMember(Description="The ID of the document to retrieve")>]
member val Id:Int64 = new Int64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetPdf() =
inherit BaseRequest()
///<summary>
///The request data
///</summary>
[<DataMember>]
[<ApiMember(Description="The request data", ParameterType="body")>]
member val Request:GetPdfRequest = null with 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"}}}}