| Get all PEP searches |
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract
open class GetPepSearches : BaseRequest()
{
@DataMember
var request:GetPepSearchesRequest? = null
}
@DataContract
open class BaseRequest : IBaseRequest
{
/**
* The authentication credentials
*/
@DataMember
@ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
var authentication:Authentication? = null
}
@DataContract
open 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")
var apiUserId:String? = 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")
var apiUserKey:String? = null
}
open class GetPepSearchesRequest
{
/**
* If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
*/
@ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
var subUserName:String? = null
var listUnresolvedSearches:Boolean? = null
var listUpdatedSearches:Boolean? = null
var listArchivedSearches:Boolean? = null
var page:Int? = null
var sortOrder:String? = null
var nameSearch:String? = null
var nameSearchExact:Boolean? = null
var filterReference:String? = null
var filterPepType:String? = null
var filterType:String? = null
var filterDateFrom:Date? = null
var filterDateTo:Date? = null
/**
* If set, will only return searches created by the user
*/
@ApiMember(Description="If set, will only return searches created by the user")
var filterUserName:String? = null
}
@DataContract
open class GetPepSearchesResponse
{
@DataMember
@SerializedName("data") var Data:GetPepSearchesData? = null
}
open class GetPepSearchesData : BaseResponse()
{
var totalSearchRecords:Int? = null
var currentPageNum:Int? = null
var maxPageNum:Int? = null
var searchRecords:ArrayOfPepSearchListItem? = null
}
open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
/**
* The status of the response
*/
@ApiMember(Description="The status of the response")
var responseStatus:ResponseStatus? = null
}
open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}
open class ArrayOfPepSearchListItem : ArrayList<PepSearchListItem>()
{
}
open class PepSearchListItem
{
var id:Long? = null
var searchType:String? = null
var dateSearched:Date? = null
var dateUpdated:Date? = null
var dateRenewal:Date? = null
var dateArchived:Date? = null
var isArchived:Boolean? = null
var numOfResults:Int? = null
var clientInResults:Boolean? = null
var clientNotInResults:Boolean? = null
var affectedByUpdate:Boolean? = null
var isDayOneSearch:Boolean? = null
var searchCriteria:SearchCriteria? = null
}
open class SearchCriteria
{
var name:String? = null
var address:String? = null
var country:String? = null
var dateOfBirth:String? = null
var nationality:String? = null
var reference:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetPepSearches
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterPepType>String</FilterPepType>
<FilterReference>String</FilterReference>
<FilterType>String</FilterType>
<FilterUserName>String</FilterUserName>
<ListArchivedSearches>false</ListArchivedSearches>
<ListUnresolvedSearches>false</ListUnresolvedSearches>
<ListUpdatedSearches>false</ListUpdatedSearches>
<NameSearch>String</NameSearch>
<NameSearchExact>false</NameSearchExact>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetPepSearches>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPepSearchesResponse 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>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<SearchRecords>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateRenewal>0001-01-01T00:00:00</DateRenewal>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<IsDayOneSearch>false</IsDayOneSearch>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchType>String</SearchType>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetPepSearchesResponse>
</soap:Body>
</soap:Envelope>