Sanctions Search API: v2

<back to all web services

CountIncompleteClients

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class CountIncompleteClients extends BaseRequest
    {
        /**
        * How many days should have elapsed before counting a Client as incomplete (defaults to 7 days).Set to zero to count all incomplete clients
        */
        @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 Integer daysIncomplete = null;

        /**
        * Count clients that match the state specified (only PendingCompletion, or PendingVerification).
        */
        @DataMember
        @ApiMember(Description="Count clients that match the state specified (only PendingCompletion, or PendingVerification).", ParameterType="query")
        public ClientState state = null;

        /**
        * Count clients that match the IsValidateMe flag specified (defaults to true).
        */
        @DataMember
        @ApiMember(Description="Count clients that match the IsValidateMe flag specified (defaults to true).", ParameterType="query")
        public Boolean isValidateMe = null;
        
        public Integer getDaysIncomplete() { return daysIncomplete; }
        public CountIncompleteClients setDaysIncomplete(Integer value) { this.daysIncomplete = value; return this; }
        public ClientState getState() { return state; }
        public CountIncompleteClients setState(ClientState value) { this.state = value; return this; }
        public Boolean getIsValidateMe() { return isValidateMe; }
        public CountIncompleteClients setIsValidateMe(Boolean value) { this.isValidateMe = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static class Authentication
    {
        /**
        * 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)
        */
        @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 String apiUserId = null;

        /**
        * 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)
        */
        @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 String apiUserKey = null;

        /**
        * 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).
        */
        @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 String userId = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
        public String getUserId() { return userId; }
        public Authentication setUserId(String value) { this.userId = value; return this; }
    }

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

    @DataContract
    public static class CountIncompleteClientsResponse
    {
        @DataMember
        public CountIncompleteClientsData data = null;
        
        public CountIncompleteClientsData getData() { return data; }
        public CountIncompleteClientsResponse setData(CountIncompleteClientsData value) { this.data = value; return this; }
    }

    public static class CountIncompleteClientsData extends BaseResponse
    {
        public Long numberOfIncompleteClients = null;
        
        public Long getNumberOfIncompleteClients() { return numberOfIncompleteClients; }
        public CountIncompleteClientsData setNumberOfIncompleteClients(Long value) { this.numberOfIncompleteClients = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

}

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