| POST | /sanctions/get | Get a sanctions search |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract
open class GetSearch : BaseRequest()
{
@DataMember
var request:GetSearchRequest? = 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 GetSearchRequest
{
/**
* If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
*/
@ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
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")
var onlyShowUnresolvedResults:Boolean? = null
var id:Long? = null
}
@DataContract
open class GetSearchResponse
{
@DataMember
@SerializedName("data") var Data:GetSearchData? = null
}
open class GetSearchData : BaseResponse(), IBaseSearchResponse
{
var linkedTo:ArrayOfLinkedTo? = null
var searchRecord:SearchRecord? = 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 ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}
open class LinkedTo
{
var clientId:Int? = null
var id:Long? = null
@SerializedName("type") var Type:String? = null
var subtype:String? = null
var status:String? = null
var description:String? = null
var isArchived:Boolean? = null
var name:String? = null
var date:Date? = null
}
open class SearchRecord
{
var id:Long? = null
var searchType:String? = null
var dateSearched:Date? = null
var dateUpdated: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 searchCriteria:SearchCriteria? = null
var searchResults:SearchResults? = null
var searchSources:ArrayList<SearchSource> = ArrayList<SearchSource>()
var listSearchResults:ArrayOfSearchResultEntries? = 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
}
open class SearchResults
{
var euResults:ArrayList<SearchResultEu> = ArrayList<SearchResultEu>()
var hmtResults:ArrayList<SearchResultHmTreasury> = ArrayList<SearchResultHmTreasury>()
var hmtUkraineResults:ArrayList<SearchResultHmTreasury> = ArrayList<SearchResultHmTreasury>()
var ofacResults:ArrayList<SearchResultOfac> = ArrayList<SearchResultOfac>()
var ofacConsolidatedResults:ArrayList<SearchResultOfac> = ArrayList<SearchResultOfac>()
var dfatResults:ArrayList<SearchResultDfat> = ArrayList<SearchResultDfat>()
var osfiResults:ArrayList<SearchResultOsfi> = ArrayList<SearchResultOsfi>()
var canadianJusticeResults:ArrayList<SearchResultCanadianJustice> = ArrayList<SearchResultCanadianJustice>()
var canadianSemaResults:ArrayList<SearchResultCanadianSema> = ArrayList<SearchResultCanadianSema>()
var swissSecoResults:ArrayList<SearchResultEntry> = ArrayList<SearchResultEntry>()
}
open class SearchResultEu
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var addresses:ArrayList<SearchResultEuAddress> = ArrayList<SearchResultEuAddress>()
var births:ArrayList<SearchResultEuBirth> = ArrayList<SearchResultEuBirth>()
var citizenships:ArrayList<SearchResultOfacEuCitizenship> = ArrayList<SearchResultOfacEuCitizenship>()
var names:ArrayList<SearchResultEuName> = ArrayList<SearchResultEuName>()
var passports:ArrayList<SearchResultEuPassport> = ArrayList<SearchResultEuPassport>()
}
open class SearchResultEuAddress
{
var street:String? = null
var city:String? = null
var country:String? = null
var postCode:String? = null
var other:String? = null
}
open class SearchResultEuBirth
{
var date:String? = null
var place:String? = null
var country:String? = null
}
open class SearchResultOfacEuCitizenship
{
var country:String? = null
}
open class SearchResultEuName
{
var fullName:String? = null
var gender:String? = null
}
open class SearchResultEuPassport
{
var number:String? = null
var country:String? = null
}
open class SearchResultHmTreasury
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateListed:Date? = null
var dateUpdated:Date? = null
var name1:String? = null
var name2:String? = null
var name3:String? = null
var name4:String? = null
var name5:String? = null
var name6:String? = null
var dateOfBirth:String? = null
var countryOfBirth:String? = null
var nationality:String? = null
var address1:String? = null
var address2:String? = null
var address3:String? = null
var address4:String? = null
var address5:String? = null
var address6:String? = null
var postCode:String? = null
var country:String? = null
}
open class SearchResultOfac
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var firstName:String? = null
var lastName:String? = null
var addresses:ArrayList<SearchResultOfacAddress> = ArrayList<SearchResultOfacAddress>()
var akas:ArrayList<SearchResultOfacAka> = ArrayList<SearchResultOfacAka>()
var dateOfBirths:ArrayList<SearchResultOfacDateOfBirth> = ArrayList<SearchResultOfacDateOfBirth>()
var nationalities:ArrayList<SearchResultOfacNationality> = ArrayList<SearchResultOfacNationality>()
var placeOfBirths:ArrayList<SearchResultOfacPlaceOfBirth> = ArrayList<SearchResultOfacPlaceOfBirth>()
}
open class SearchResultOfacAddress
{
var address1:String? = null
var address2:String? = null
var address3:String? = null
var city:String? = null
var state:String? = null
var postCode:String? = null
var country:String? = null
}
open class SearchResultOfacAka
{
var firstName:String? = null
var lastName:String? = null
@SerializedName("type") var Type:String? = null
var strength:String? = null
}
open class SearchResultOfacDateOfBirth
{
var dateOfBirth:String? = null
}
open class SearchResultOfacNationality
{
var country:String? = null
}
open class SearchResultOfacPlaceOfBirth
{
var placeOfBirth:String? = null
}
open class SearchResultDfat
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var fullName:String? = null
var address:String? = null
var dateOfBirth:String? = null
var placeOfBirth:String? = null
var nationality:String? = null
}
open class SearchResultOsfi
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var fullName:String? = null
var address:String? = null
var dateOfBirth:String? = null
var placeOfBirth:String? = null
var nationality:String? = null
}
open class SearchResultCanadianJustice
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var name:String? = null
var dateOfBirth:String? = null
var country:String? = null
var refId:Int? = null
}
open class SearchResultCanadianSema
{
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var name:String? = null
var dateOfBirth:String? = null
var country:String? = null
var schedule:String? = null
var item:String? = null
}
open class SearchResultEntry
{
var searchResultId:Long? = null
var resultStrength:Int? = null
var resultSimilarity:BigDecimal? = null
var resultResolved:Boolean? = null
var resultType:String? = null
var dateUpdated:Date? = null
var sanctionsListId:String? = null
var sanctionsListName:String? = null
var addresses:ArrayList<SearchResultAddress> = ArrayList<SearchResultAddress>()
var datesOfBirth:ArrayList<SearchResultDateOfBirth> = ArrayList<SearchResultDateOfBirth>()
var names:ArrayList<SearchResultName> = ArrayList<SearchResultName>()
var nationalities:ArrayList<SearchResultNationality> = ArrayList<SearchResultNationality>()
var placesOfBirth:ArrayList<SearchResultPlaceOfBirth> = ArrayList<SearchResultPlaceOfBirth>()
var remarks:ArrayList<SearchResultRemark> = ArrayList<SearchResultRemark>()
}
open class SearchResultAddress
{
var searchResultAddressId:Long? = null
@SerializedName("type") var Type:String? = null
var address1:String? = null
var address2:String? = null
var address3:String? = null
var city:String? = null
var county:String? = null
var postCode:String? = null
var country:String? = null
}
open class SearchResultDateOfBirth
{
var searchResultDateOfBirthId:Long? = null
var dateOfBirth:String? = null
var year:Short? = null
var month:Short? = null
var day:Short? = null
@SerializedName("type") var Type:String? = null
}
open class SearchResultName
{
var searchResultNameId:Long? = null
@SerializedName("type") var Type:String? = null
var title:String? = null
var fullName:String? = null
var resultSimilarity:BigDecimal? = null
}
open class SearchResultNationality
{
var searchResultNationalityId:Long? = null
var nationality:String? = null
}
open class SearchResultPlaceOfBirth
{
var searchResultPlaceOfBirthId:Long? = null
var placeOfBirth:String? = null
var countryOfBirth:String? = null
}
open class SearchResultRemark
{
var searchResultRemarkId:Long? = null
var name:String? = null
var description:String? = null
}
open class SearchSource
{
var listId:String? = null
var listName:String? = null
var listShortName:String? = null
var isAffectedByListUpdate:Boolean? = null
}
open class ArrayOfSearchResultEntries : ArrayList<SearchResultEntry>()
{
}
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 /sanctions/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"hmtResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"hmtUkraineResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"ofacResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"ofacConsolidatedResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}