Sanctions Search API: v2

<back to all web services

RenewPepSearches

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

public class dtos
{

    @DataContract
    public static class RenewPepSearches extends BaseRequest
    {
        @DataMember
        public RenewPepSearchesRequest request = null;
        
        public RenewPepSearchesRequest getRequest() { return request; }
        public RenewPepSearches setRequest(RenewPepSearchesRequest 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. 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; }
    }

    public static class RenewPepSearchesRequest
    {
        public ArrayOfLong ids = null;
        public Date dateRenewal = null;
        
        public ArrayOfLong getIds() { return ids; }
        public RenewPepSearchesRequest setIds(ArrayOfLong value) { this.ids = value; return this; }
        public Date getDateRenewal() { return dateRenewal; }
        public RenewPepSearchesRequest setDateRenewal(Date value) { this.dateRenewal = value; return this; }
    }

    public static class ArrayOfLong extends ArrayList<Long>
    {
        
    }

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

    public static class RenewPepSearchesData extends BaseResponse
    {
        public Integer count = null;
        public BigDecimal totalCost = null;
        public ArrayList<Long> failedIds = null;
        
        public Integer getCount() { return count; }
        public RenewPepSearchesData setCount(Integer value) { this.count = value; return this; }
        public BigDecimal getTotalCost() { return totalCost; }
        public RenewPepSearchesData setTotalCost(BigDecimal value) { this.totalCost = value; return this; }
        public ArrayList<Long> getFailedIds() { return failedIds; }
        public RenewPepSearchesData setFailedIds(ArrayList<Long> value) { this.failedIds = 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 RenewPepSearches DTOs

PUT /peps/renew/selected HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"ids":[0],"dateRenewal":"\/Date(-62135596800000-0000)\/"},"authentication":{"apiUserId":"String","apiUserKey":"String","userId":"String"}}

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

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