Sanctions Search API: v2

CountUpdatedPepSearches

PEP

The following routes are available for this service:
POST	/peps/updated/count	Get the count of PEP searches affected by updates

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

public class dtos
{

    @DataContract
    public static class CountUpdatedPepSearches extends BaseRequest
    {
        @DataMember
        public CountUpdatedPepSearchesRequest request = null;
        
        public CountUpdatedPepSearchesRequest getRequest() { return request; }
        public CountUpdatedPepSearches setRequest(CountUpdatedPepSearchesRequest value) { this.request = 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
        */
        @DataMember
        @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserId = null;

        /**
        * The API User Key provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserKey = 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 static class CountUpdatedPepSearchesRequest
    {
        public Boolean includeSearchesFromOtherUsers = null;
        
        public Boolean isIncludeSearchesFromOtherUsers() { return includeSearchesFromOtherUsers; }
        public CountUpdatedPepSearchesRequest setIncludeSearchesFromOtherUsers(Boolean value) { this.includeSearchesFromOtherUsers = value; return this; }
    }

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

    public static class CountUpdatedPepSearchesData extends BaseResponse
    {
        public Long numberOfUpdatedPepSearches = null;
        
        public Long getNumberOfUpdatedPepSearches() { return numberOfUpdatedPepSearches; }
        public CountUpdatedPepSearchesData setNumberOfUpdatedPepSearches(Long value) { this.numberOfUpdatedPepSearches = 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 CountUpdatedPepSearches DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /peps/updated/count HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CountUpdatedPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <IncludeSearchesFromOtherUsers>false</IncludeSearchesFromOtherUsers>
  </Request>
</CountUpdatedPepSearches>

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

<CountUpdatedPepSearchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <NumberOfUpdatedPepSearches>0</NumberOfUpdatedPepSearches>
  </Data>
</CountUpdatedPepSearchesResponse>