| POST | /validid/status | Get the ValidID status - whether it is enabled or not |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class CheckValidIdStatus extends BaseRequest
{
}
@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; }
}
@DataContract
public static class CheckValidIdStatusResponse
{
@DataMember
public CheckValidIdStatusData data = null;
public CheckValidIdStatusData getData() { return data; }
public CheckValidIdStatusResponse setData(CheckValidIdStatusData value) { this.data = value; return this; }
}
public static class CheckValidIdStatusData extends BaseResponse
{
public Boolean validIdActivated = null;
public String agreementText = null;
public Boolean isValidIdActivated() { return validIdActivated; }
public CheckValidIdStatusData setValidIdActivated(Boolean value) { this.validIdActivated = value; return this; }
public String getAgreementText() { return agreementText; }
public CheckValidIdStatusData setAgreementText(String value) { this.agreementText = 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>
{
}
}
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.
POST /validid/status HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"validIdActivated":false,"agreementText":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}