| GET | /clients/proofs/defaults | Get the configured default categories of proof and their documents | |
|---|---|---|---|
| GET | /clients/proofs | Get all categories of proof and their documents |
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
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 ProofOfDocument() =
///<summary>
///The ID of the ProofOfDocument
///</summary>
[<ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The name of the ProofOfDocument
///</summary>
[<ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)>]
member val Name:String = null with get,set
[<AllowNullLiteral>]
type ArrayOfProofOfDocuments() =
inherit ResizeArray<ProofOfDocument>()
[<AllowNullLiteral>]
type ProofOfDocumentCategory() =
///<summary>
///The ID of the ProofOfDocumentCategory
///</summary>
[<ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
///</summary>
[<ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)>]
member val ProofOf:String = null with get,set
///<summary>
///The documents that can be used to provide proof for the specified category.
///</summary>
[<ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)>]
member val ProofOfDocuments:ArrayOfProofOfDocuments = null with get,set
[<AllowNullLiteral>]
type ArrayOfProofOfDocumentCategories() =
inherit ResizeArray<ProofOfDocumentCategory>()
[<AllowNullLiteral>]
type GetProofOfDocumentCategoriesData() =
inherit BaseResponse()
member val ProofOfDocumentCategories:ArrayOfProofOfDocumentCategories = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetProofOfDocumentCategoriesResponse() =
[<DataMember>]
member val Data:GetProofOfDocumentCategoriesData = 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
[<DataContract>]
[<AllowNullLiteral>]
type GetProofOfDocumentCategories() =
inherit BaseRequest()
[<DataMember>]
member val OnlyDefaults:Boolean = new Boolean() with get,set
F# GetProofOfDocumentCategories DTOs
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.
GET /clients/proofs/defaults HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}