| Get a PEP search |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract
open class GetPepSearch : BaseRequest()
{
@DataMember
open var request:GetPepSearchRequest? = null
}
@DataContract
open class BaseRequest : IBaseRequest
{
/**
* The authentication credentials
*/
@DataMember
@ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
override var authentication:Authentication? = null
}
@DataContract
open 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")
open var apiUserId:String? = 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")
open var apiUserKey:String? = 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")
open var userId:String? = null
}
open class GetPepSearchRequest
{
/**
* If the search was created against a single Sub User account, specify their username here
*/
@ApiMember(Description="If the search was created against a single Sub User account, specify their username here")
open var subUserName:String? = null
/**
* If set to true, the response will exclude resolved search results, it will only include unresolved results
*/
@ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
open var onlyShowUnresolvedResults:Boolean? = null
open var id:Long? = null
}
@DataContract
open class GetPepSearchResponse
{
@DataMember
@SerializedName("data") open var Data:GetPepSearchData? = null
}
open class GetPepSearchData : BaseResponse(), IBaseSearchResponse
{
override var linkedTo:ArrayOfLinkedTo? = null
open var searchRecord:PepSearchRecord? = null
}
open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
/**
* The status of the response
*/
@ApiMember(Description="The status of the response")
override var responseStatus:ResponseStatus? = null
}
open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}
open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}
open class LinkedTo
{
open var clientId:Int? = null
open var id:Long? = null
@SerializedName("type") open var Type:String? = null
open var subtype:String? = null
open var status:String? = null
open var description:String? = null
open var isArchived:Boolean? = null
open var name:String? = null
open var date:Date? = null
}
open class PepSearchRecord
{
open var id:Long? = null
open var searchType:String? = null
open var dateSearched:Date? = null
open var dateUpdated:Date? = null
open var dateRenewal:Date? = null
open var dateArchived:Date? = null
open var isArchived:Boolean? = null
open var numOfResults:Int? = null
open var clientInResults:Boolean? = null
open var clientNotInResults:Boolean? = null
open var affectedByUpdate:Boolean? = null
open var isDayOneSearch:Boolean? = null
open var searchCriteria:SearchCriteria? = null
open var searchResults:PepSearchResults? = null
}
open class SearchCriteria
{
open var name:String? = null
open var address:String? = null
open var country:String? = null
open var dateOfBirth:String? = null
open var nationality:String? = null
open var reference:String? = null
}
open class PepSearchResults
{
open var results:ArrayList<PepSearchResult>? = null
}
open class PepSearchResult
{
open var resultSimilarity:BigDecimal? = null
open var resultResolved:Boolean? = null
open var dateLastUpdated:Date? = null
open var resultIsClient:Boolean? = null
open var id:Long? = null
@SerializedName("type") open var Type:String? = null
open var title:String? = null
open var forename:String? = null
open var middlename:String? = null
open var surname:String? = null
open var softDelete:Boolean? = null
open var dateOfSoftDelete:Date? = null
open var dateOfCapture:Date? = null
open var dateOfBirth:Date? = null
open var dateOfDeath:Date? = null
open var yearOfBirth:Int? = null
open var yearOfDeath:Int? = null
open var gender:String? = null
open var homeTelephone:String? = null
open var businessTelephone:String? = null
open var mobileTelephone:String? = null
open var fax:String? = null
open var email:String? = null
open var nationality:String? = null
open var source:String? = null
open var category:String? = null
open var picture:String? = null
open var alternateTitle:String? = null
open var businessName:String? = null
open var description:String? = null
open var telephone:String? = null
open var website:String? = null
open var pepTier:Int? = null
open var faceIsMatch:Boolean? = null
open var faceIsMatchConfidence:BigDecimal? = null
open var addresses:ArrayList<PepSearchResultAddress>? = null
open var aliases:ArrayList<PepSearchResultAlias>? = null
open var articles:ArrayList<PepSearchResultArticle>? = null
open var associations:ArrayList<PepSearchResultIndividualAssociation>? = null
open var businessAssociations:ArrayList<PepSearchResultBusinessAssociation>? = null
open var notes:ArrayList<PepSearchResultNote>? = null
open var politicalPositions:ArrayList<PepSearchResultPoliticalPosition>? = null
}
open class PepSearchResultAddress
{
open var addressLine1:String? = null
open var addressLine2:String? = null
open var addressLine3:String? = null
open var addressLine4:String? = null
open var town:String? = null
open var county:String? = null
open var postCode:String? = null
open var country:String? = null
open var isoCountry:String? = null
open var softDelete:Boolean? = null
open var dateLastUpdated:Date? = null
}
open class PepSearchResultAlias
{
open var forename:String? = null
open var middleName:String? = null
open var surname:String? = null
open var softDelete:Boolean? = null
open var dateOfSoftDelete:Date? = null
open var dateLastUpdated:Date? = null
open var title:String? = null
open var alternateTitle:String? = null
open var businessName:String? = null
}
open class PepSearchResultArticle
{
open var url:String? = null
open var originalUrl:String? = null
open var source:String? = null
open var dateOfCapture:Date? = null
open var dateLastUpdated:Date? = null
open var snippets:ArrayList<PepSearchResultArticleSnippet>? = null
}
open class PepSearchResultArticleSnippet
{
open var title:String? = null
open var text:String? = null
open var adverseTerms:String? = null
}
open class PepSearchResultIndividualAssociation
{
open var linkDescription:String? = null
open var softDelete:Boolean? = null
open var dateLastUpdated:Date? = null
open var fullName:String? = null
}
open class PepSearchResultBusinessAssociation
{
open var linkDescription:String? = null
open var softDelete:Boolean? = null
open var dateLastUpdated:Date? = null
open var businessName:String? = null
}
open class PepSearchResultNote
{
open var source:String? = null
open var notes:String? = null
open var softDelete:Boolean? = null
open var dateLastUpdated:Date? = null
}
open class PepSearchResultPoliticalPosition
{
open var description:String? = null
open var from:String? = null
open var to:String? = null
open var country:String? = null
open var softDelete:Boolean? = null
open var dateLastUpdated:Date? = null
}
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.simplified.id
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>
<GetPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
<UserId>String</UserId>
</Authentication>
<Request>
<Id>0</Id>
<OnlyShowUnresolvedResults>false</OnlyShowUnresolvedResults>
<SubUserName>String</SubUserName>
</Request>
</GetPepSearch>
</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>
<GetPepSearchResponse 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>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<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>
<SearchResults>
<Results>
<PepSearchResult>
<Addresses>
<PepSearchResultAddress>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressLine4>String</AddressLine4>
<Country>String</Country>
<County>String</County>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<ISOCountry>String</ISOCountry>
<PostCode>String</PostCode>
<SoftDelete>false</SoftDelete>
<Town>String</Town>
</PepSearchResultAddress>
</Addresses>
<Aliases>
<PepSearchResultAlias>
<AlternateTitle>String</AlternateTitle>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Forename>String</Forename>
<MiddleName>String</MiddleName>
<SoftDelete>false</SoftDelete>
<Surname>String</Surname>
<Title>String</Title>
</PepSearchResultAlias>
</Aliases>
<AlternateTitle>String</AlternateTitle>
<Articles>
<PepSearchResultArticle>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<OriginalUrl>String</OriginalUrl>
<Snippets>
<PepSearchResultArticleSnippet>
<AdverseTerms>String</AdverseTerms>
<Text>String</Text>
<Title>String</Title>
</PepSearchResultArticleSnippet>
</Snippets>
<Source>String</Source>
<Url>String</Url>
</PepSearchResultArticle>
</Articles>
<Associations>
<PepSearchResultIndividualAssociation>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<FullName>String</FullName>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultIndividualAssociation>
</Associations>
<BusinessAssociations>
<PepSearchResultBusinessAssociation>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultBusinessAssociation>
</BusinessAssociations>
<BusinessName>String</BusinessName>
<BusinessTelephone>String</BusinessTelephone>
<Category>String</Category>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<DateOfDeath>0001-01-01T00:00:00</DateOfDeath>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Description>String</Description>
<Email>String</Email>
<FaceIsMatch>false</FaceIsMatch>
<FaceIsMatchConfidence>0</FaceIsMatchConfidence>
<Fax>String</Fax>
<Forename>String</Forename>
<Gender>String</Gender>
<HomeTelephone>String</HomeTelephone>
<Id>0</Id>
<Middlename>String</Middlename>
<MobileTelephone>String</MobileTelephone>
<Nationality>String</Nationality>
<Notes>
<PepSearchResultNote>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Notes>String</Notes>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
</PepSearchResultNote>
</Notes>
<PepTier>0</PepTier>
<Picture>String</Picture>
<PoliticalPositions>
<PepSearchResultPoliticalPosition>
<Country>String</Country>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Description>String</Description>
<From>String</From>
<SoftDelete>false</SoftDelete>
<To>String</To>
</PepSearchResultPoliticalPosition>
</PoliticalPositions>
<ResultIsClient>false</ResultIsClient>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
<Surname>String</Surname>
<Telephone>String</Telephone>
<Title>String</Title>
<Type>String</Type>
<Website>String</Website>
<YearOfBirth>0</YearOfBirth>
<YearOfDeath>0</YearOfDeath>
</PepSearchResult>
</Results>
</SearchResults>
<SearchType>String</SearchType>
</SearchRecord>
</Data>
</GetPepSearchResponse>
</soap12:Body>
</soap12:Envelope>