Sanctions Search API: v2

<back to all web services

GetProofOfDocumentCategories

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Clients;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

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.Operations.Clients
{
    [DataContract]
    public partial class GetProofOfDocumentCategories
        : BaseRequest
    {
        [DataMember]
        public virtual bool OnlyDefaults { get; set; }
    }

    public partial class GetProofOfDocumentCategoriesData
        : BaseResponse
    {
        public virtual ArrayOfProofOfDocumentCategories ProofOfDocumentCategories { get; set; }
    }

    [DataContract]
    public partial class GetProofOfDocumentCategoriesResponse
    {
        [DataMember]
        public virtual GetProofOfDocumentCategoriesData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfProofOfDocumentCategories
        : List<ProofOfDocumentCategory>
    {
    }

    public partial class ArrayOfProofOfDocuments
        : List<ProofOfDocument>
    {
    }

    [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 ProofOfDocument
    {
        ///<summary>
        ///The ID of the ProofOfDocument
        ///</summary>
        [ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)]
        public virtual int Id { get; set; }

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

    public partial class ProofOfDocumentCategory
    {
        ///<summary>
        ///The ID of the ProofOfDocumentCategory
        ///</summary>
        [ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)]
        public virtual int Id { 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)]
        public virtual string ProofOf { 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)]
        public virtual ArrayOfProofOfDocuments ProofOfDocuments { get; set; }
    }

}

C# GetProofOfDocumentCategories DTOs

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