| POST | /sanctions/entity/get | Create a get a sanctions search for an entity | This will get a new sanctions search for an entity, such as a company, vessel, organisation, or group. |
|---|
namespace Nugo.SanctionsSearch.Api.ServiceModel.Operations
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ResponseError() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val FieldName:String = null with get,set
[<DataMember(Order=3)>]
member val Message:String = null with get,set
[<AllowNullLiteral>]
type ArrayOfResponseError() =
inherit ResizeArray<ResponseError>()
[<DataContract>]
[<AllowNullLiteral>]
type ResponseStatus() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val Message:String = null with get,set
[<DataMember(Order=3)>]
member val StackTrace:String = null with get,set
[<DataMember(Order=4)>]
member val Errors:ArrayOfResponseError = null with get,set
[<AllowNullLiteral>]
type SearchCriteria() =
member val Name:String = null with get,set
member val DateOfBirth:String = null with get,set
member val CountryOfBirth:String = null with get,set
member val Nationality:String = null with get,set
member val Address:String = null with get,set
[<AllowNullLiteral>]
type SearchResultHmTreasury() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateListed:DateTime = new DateTime() with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val Name1:String = null with get,set
member val Name2:String = null with get,set
member val Name3:String = null with get,set
member val Name4:String = null with get,set
member val Name5:String = null with get,set
member val Name6:String = null with get,set
member val DateOfBirth:String = null with get,set
member val CountryOfBirth:String = null with get,set
member val Nationality:String = null with get,set
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val Address4:String = null with get,set
member val Address5:String = null with get,set
member val Address6:String = null with get,set
member val PostCode:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacAddress() =
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val City:String = null with get,set
member val State:String = null with get,set
member val PostCode:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacAka() =
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Type:String = null with get,set
member val Strength:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacDateOfBirth() =
member val DateOfBirth:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacNationality() =
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacPlaceOfBirth() =
member val PlaceOfBirth:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfac() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Addresses:ResizeArray<SearchResultOfacAddress> = new ResizeArray<SearchResultOfacAddress>() with get,set
member val Akas:ResizeArray<SearchResultOfacAka> = new ResizeArray<SearchResultOfacAka>() with get,set
member val DateOfBirths:ResizeArray<SearchResultOfacDateOfBirth> = new ResizeArray<SearchResultOfacDateOfBirth>() with get,set
member val Nationalities:ResizeArray<SearchResultOfacNationality> = new ResizeArray<SearchResultOfacNationality>() with get,set
member val PlaceOfBirths:ResizeArray<SearchResultOfacPlaceOfBirth> = new ResizeArray<SearchResultOfacPlaceOfBirth>() with get,set
[<AllowNullLiteral>]
type SearchResults() =
member val HMTResults:ResizeArray<SearchResultHmTreasury> = new ResizeArray<SearchResultHmTreasury>() with get,set
member val OfacResults:ResizeArray<SearchResultOfac> = new ResizeArray<SearchResultOfac>() with get,set
[<AllowNullLiteral>]
type SearchRecord() =
member val Id:Int64 = new Int64() with get,set
member val SearchType:String = null with get,set
member val DateSearched:DateTime = new DateTime() with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val NumOfResults:Int32 = new Int32() with get,set
member val ClientInResults:Boolean = new Boolean() with get,set
member val ClientNotInResults:Boolean = new Boolean() with get,set
member val AffectedByUpdate:Boolean = new Boolean() with get,set
member val SearchCriteria:SearchCriteria = null with get,set
member val SearchResults:SearchResults = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetCompanySearchData() =
[<DataMember>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataMember>]
member val SearchRecord:SearchRecord = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetCompanySearchResponse() =
[<DataMember>]
member val Data:GetCompanySearchData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Authentication() =
///<summary>
///The API User ID that will authenticate your request
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)>]
member val ApiUserId:String = null with get,set
///<summary>
///The API User Key that will authenticate your request
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)>]
member val ApiUserKey:String = null with get,set
[<ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)>]
[<DataContract>]
[<AllowNullLiteral>]
type GetCompanySearch() =
[<DataMember>]
member val Authentication:Authentication = null with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
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/entity/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"SearchRecord":{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"},"SearchResults":{"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"}],"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"}]}]}}}}