| GET | /peps/renew/all | Get total cost of renewing all PEP searches due for renewal |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class CostRenewAllPepSearches extends BaseRequest
{
@DataMember
public CostRenewAllPepSearchesRequest request = null;
public CostRenewAllPepSearchesRequest getRequest() { return request; }
public CostRenewAllPepSearches setRequest(CostRenewAllPepSearchesRequest 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 CostRenewAllPepSearchesRequest
{
public Date renewalDate = null;
public Date getRenewalDate() { return renewalDate; }
public CostRenewAllPepSearchesRequest setRenewalDate(Date value) { this.renewalDate = value; return this; }
}
@DataContract
public static class CostRenewAllPepSearchesResponse
{
@DataMember
public CostRenewAllPepSearchesData data = null;
public CostRenewAllPepSearchesData getData() { return data; }
public CostRenewAllPepSearchesResponse setData(CostRenewAllPepSearchesData value) { this.data = value; return this; }
}
public static class CostRenewAllPepSearchesData extends BaseResponse
{
public Integer count = null;
public BigDecimal totalCost = null;
public String renewalDate = null;
public Boolean canAfford = null;
public Integer getCount() { return count; }
public CostRenewAllPepSearchesData setCount(Integer value) { this.count = value; return this; }
public BigDecimal getTotalCost() { return totalCost; }
public CostRenewAllPepSearchesData setTotalCost(BigDecimal value) { this.totalCost = value; return this; }
public String getRenewalDate() { return renewalDate; }
public CostRenewAllPepSearchesData setRenewalDate(String value) { this.renewalDate = value; return this; }
public Boolean isCanAfford() { return canAfford; }
public CostRenewAllPepSearchesData setCanAfford(Boolean value) { this.canAfford = 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 CostRenewAllPepSearches DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /peps/renew/all HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"count":0,"totalCost":0,"renewalDate":"String","canAfford":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}