| Get a bulk search status |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetBulkSearchStatus extends BaseRequest
{
@DataMember
public GetBulkSearchStatusRequest request = null;
public GetBulkSearchStatusRequest getRequest() { return request; }
public GetBulkSearchStatus setRequest(GetBulkSearchStatusRequest 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 GetBulkSearchStatusRequest
{
public Integer bulkSearchId = null;
public String subUserName = null;
public Integer getBulkSearchId() { return bulkSearchId; }
public GetBulkSearchStatusRequest setBulkSearchId(Integer value) { this.bulkSearchId = value; return this; }
public String getSubUserName() { return subUserName; }
public GetBulkSearchStatusRequest setSubUserName(String value) { this.subUserName = value; return this; }
}
@DataContract
public static class GetBulkSearchStatusResponse
{
@DataMember
public GetBulkSearchStatusData data = null;
public GetBulkSearchStatusData getData() { return data; }
public GetBulkSearchStatusResponse setData(GetBulkSearchStatusData value) { this.data = value; return this; }
}
public static class GetBulkSearchStatusData extends BaseResponse
{
public BulkSearchStatus bulkSearchStatus = null;
public BulkSearchStatus getBulkSearchStatus() { return bulkSearchStatus; }
public GetBulkSearchStatusData 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetBulkSearchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request />
</GetBulkSearchStatus>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetBulkSearchStatusResponse 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>
<BulkSearchStatus>
<BulkSearchId>0</BulkSearchId>
<IsPepSearch>false</IsPepSearch>
<IsSanctionsSearch>false</IsSanctionsSearch>
<Message>String</Message>
<Processed>0</Processed>
<ProcessedPep>0</ProcessedPep>
<ProcessedSanctions>0</ProcessedSanctions>
<Status>String</Status>
<Success>false</Success>
<Total>0</Total>
<TotalPep>0</TotalPep>
<TotalSanctions>0</TotalSanctions>
</BulkSearchStatus>
</Data>
</GetBulkSearchStatusResponse>
</soap12:Body>
</soap12:Envelope>