Sanctions Search API: v2

<back to all web services

AddBulkSearch

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

public class dtos
{

    @DataContract
    public static class AddBulkSearch extends BaseRequest
    {
        @DataMember
        public AddBulkSearchRequest request = null;
        
        public AddBulkSearchRequest getRequest() { return request; }
        public AddBulkSearch setRequest(AddBulkSearchRequest 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 AddBulkSearchRequest
    {
        public Boolean isSanctionsSearch = null;
        public Boolean isPepSearch = null;
        public String type = null;
        public ArrayOfLists selectedLists = null;
        
        public Boolean getIsSanctionsSearch() { return isSanctionsSearch; }
        public AddBulkSearchRequest setIsSanctionsSearch(Boolean value) { this.isSanctionsSearch = value; return this; }
        public Boolean getIsPepSearch() { return isPepSearch; }
        public AddBulkSearchRequest setIsPepSearch(Boolean value) { this.isPepSearch = value; return this; }
        public String getType() { return type; }
        public AddBulkSearchRequest setType(String value) { this.type = value; return this; }
        public ArrayOfLists getSelectedLists() { return selectedLists; }
        public AddBulkSearchRequest setSelectedLists(ArrayOfLists value) { this.selectedLists = value; return this; }
    }

    public static class ArrayOfLists extends ArrayList<String>
    {
        
    }

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

    public static class AddBulkSearchData extends BaseResponse
    {
        public BulkSearchStatus bulkSearchStatus = null;
        
        public BulkSearchStatus getBulkSearchStatus() { return bulkSearchStatus; }
        public AddBulkSearchData setBulkSearchStatus(BulkSearchStatus value) { this.bulkSearchStatus = 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>
    {
        
    }

    public static class BulkSearchStatus
    {
        public Integer bulkSearchId = null;
        public Boolean success = null;
        public String status = null;
        public Integer total = null;
        public String message = null;
        public Integer processed = null;
        public Boolean isPepSearch = null;
        public Boolean isSanctionsSearch = null;
        public Integer totalPep = null;
        public Integer processedPep = null;
        public Integer totalSanctions = null;
        public Integer processedSanctions = null;
        
        public Integer getBulkSearchId() { return bulkSearchId; }
        public BulkSearchStatus setBulkSearchId(Integer value) { this.bulkSearchId = value; return this; }
        public Boolean isSuccess() { return success; }
        public BulkSearchStatus setSuccess(Boolean value) { this.success = value; return this; }
        public String getStatus() { return status; }
        public BulkSearchStatus setStatus(String value) { this.status = value; return this; }
        public Integer getTotal() { return total; }
        public BulkSearchStatus setTotal(Integer value) { this.total = value; return this; }
        public String getMessage() { return message; }
        public BulkSearchStatus setMessage(String value) { this.message = value; return this; }
        public Integer getProcessed() { return processed; }
        public BulkSearchStatus setProcessed(Integer value) { this.processed = value; return this; }
        public Boolean getIsPepSearch() { return isPepSearch; }
        public BulkSearchStatus setIsPepSearch(Boolean value) { this.isPepSearch = value; return this; }
        public Boolean getIsSanctionsSearch() { return isSanctionsSearch; }
        public BulkSearchStatus setIsSanctionsSearch(Boolean value) { this.isSanctionsSearch = value; return this; }
        public Integer getTotalPep() { return totalPep; }
        public BulkSearchStatus setTotalPep(Integer value) { this.totalPep = value; return this; }
        public Integer getProcessedPep() { return processedPep; }
        public BulkSearchStatus setProcessedPep(Integer value) { this.processedPep = value; return this; }
        public Integer getTotalSanctions() { return totalSanctions; }
        public BulkSearchStatus setTotalSanctions(Integer value) { this.totalSanctions = value; return this; }
        public Integer getProcessedSanctions() { return processedSanctions; }
        public BulkSearchStatus setProcessedSanctions(Integer value) { this.processedSanctions = value; return this; }
    }

}

Java AddBulkSearch DTOs

POST /bulksearches/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"isSanctionsSearch":false,"isPepSearch":false,"type":"String","selectedLists":["String"]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"bulkSearchStatus":{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}