Sanctions Search API: v2

<back to all web services

CountIncompleteClients

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 CountIncompleteClients
        : BaseRequest
    {
        ///<summary>
        ///How many days should have elapsed before counting a Client as incomplete (defaults to 7 days).Set to zero to count all incomplete clients
        ///</summary>
        [DataMember]
        [ApiMember(Description="How many days should have elapsed before counting a Client as incomplete (defaults to 7 days).Set to zero to count all incomplete clients", ParameterType="query")]
        public virtual int DaysIncomplete { get; set; }

        ///<summary>
        ///Count clients that match the state specified (only PendingCompletion, or PendingVerification).
        ///</summary>
        [DataMember]
        [ApiMember(Description="Count clients that match the state specified (only PendingCompletion, or PendingVerification).", ParameterType="query")]
        public virtual ClientState State { get; set; }

        ///<summary>
        ///Count clients that match the IsValidateMe flag specified (defaults to true).
        ///</summary>
        [DataMember]
        [ApiMember(Description="Count clients that match the IsValidateMe flag specified (defaults to true).", ParameterType="query")]
        public virtual bool IsValidateMe { get; set; }
    }

    public partial class CountIncompleteClientsData
        : BaseResponse
    {
        public virtual long NumberOfIncompleteClients { get; set; }
    }

    [DataContract]
    public partial class CountIncompleteClientsResponse
    {
        [DataMember]
        public virtual CountIncompleteClientsData Data { 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. Can be provided in the request body, or as a header parameter (X-Api-User)
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", 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. Can be provided in the request body, or as a header parameter (X-Api-Key)
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }

        ///<summary>
        ///The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
        ///</summary>
        [DataMember]
        [ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")]
        public virtual string UserId { get; set; }
    }

    [DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types")]
    public enum ClientState
    {
        Undefined,
        PendingCompletion,
        PendingOcr,
        PendingVerification,
        Verified,
    }

}

C# CountIncompleteClients DTOs

GET /clients/incomplete/count HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"numberOfIncompleteClients":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}