| 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. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Nugo.SanctionsSearch.Api.ServiceModel.Operations;
using Nugo.SanctionsSearch.Api.ServiceModel.Types;
using Nugo.SanctionsSearch.Api.ServiceModel.Operations.Base;
namespace Nugo.SanctionsSearch.Api.ServiceModel.Operations
{
[ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)]
[DataContract]
public partial class GetCompanySearch
: IBaseRequest
{
[DataMember]
public virtual Authentication Authentication { get; set; }
[DataMember]
public virtual long Id { get; set; }
}
[DataContract]
public partial class GetCompanySearchData
: IBaseDataResponse, IHasResponseStatus
{
[DataMember]
public virtual ResponseStatus ResponseStatus { get; set; }
[DataMember]
public virtual SearchRecord SearchRecord { get; set; }
}
[DataContract]
public partial class GetCompanySearchResponse
{
[DataMember]
public virtual GetCompanySearchData Data { get; set; }
}
}
namespace Nugo.SanctionsSearch.Api.ServiceModel.Operations.Base
{
public partial class ArrayOfResponseError
: List<ResponseError>
{
}
[DataContract]
public partial class ResponseError
{
[DataMember(Order=1)]
public virtual string ErrorCode { get; set; }
[DataMember(Order=2)]
public virtual string FieldName { get; set; }
[DataMember(Order=3)]
public virtual string Message { get; set; }
}
[DataContract]
public partial class ResponseStatus
{
[DataMember(Order=1)]
public virtual string ErrorCode { get; set; }
[DataMember(Order=2)]
public virtual string Message { get; set; }
[DataMember(Order=3)]
public virtual string StackTrace { get; set; }
[DataMember(Order=4)]
public virtual ArrayOfResponseError Errors { get; set; }
}
}
namespace Nugo.SanctionsSearch.Api.ServiceModel.Types
{
[DataContract]
public partial class Authentication
: IAuthentication
{
///<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)]
public virtual string ApiUserId { 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)]
public virtual string ApiUserKey { get; set; }
}
public partial class SearchCriteria
{
public virtual string Name { get; set; }
public virtual string DateOfBirth { get; set; }
public virtual string CountryOfBirth { get; set; }
public virtual string Nationality { get; set; }
public virtual string Address { get; set; }
}
public partial class SearchRecord
{
public virtual long Id { get; set; }
public virtual string SearchType { get; set; }
public virtual DateTime DateSearched { get; set; }
public virtual DateTime DateUpdated { get; set; }
public virtual int NumOfResults { get; set; }
public virtual bool ClientInResults { get; set; }
public virtual bool ClientNotInResults { get; set; }
public virtual bool AffectedByUpdate { get; set; }
public virtual SearchCriteria SearchCriteria { get; set; }
public virtual SearchResults SearchResults { get; set; }
}
public partial class SearchResultHmTreasury
{
public virtual int ResultStrength { get; set; }
public virtual decimal ResultSimilarity { get; set; }
public virtual bool ResultResolved { get; set; }
public virtual string ResultType { get; set; }
public virtual DateTime DateListed { get; set; }
public virtual DateTime DateUpdated { get; set; }
public virtual string Name1 { get; set; }
public virtual string Name2 { get; set; }
public virtual string Name3 { get; set; }
public virtual string Name4 { get; set; }
public virtual string Name5 { get; set; }
public virtual string Name6 { get; set; }
public virtual string DateOfBirth { get; set; }
public virtual string CountryOfBirth { get; set; }
public virtual string Nationality { get; set; }
public virtual string Address1 { get; set; }
public virtual string Address2 { get; set; }
public virtual string Address3 { get; set; }
public virtual string Address4 { get; set; }
public virtual string Address5 { get; set; }
public virtual string Address6 { get; set; }
public virtual string PostCode { get; set; }
public virtual string Country { get; set; }
}
public partial class SearchResultOfac
{
public SearchResultOfac()
{
Addresses = new List<SearchResultOfacAddress>{};
Akas = new List<SearchResultOfacAka>{};
DateOfBirths = new List<SearchResultOfacDateOfBirth>{};
Nationalities = new List<SearchResultOfacNationality>{};
PlaceOfBirths = new List<SearchResultOfacPlaceOfBirth>{};
}
public virtual int ResultStrength { get; set; }
public virtual decimal ResultSimilarity { get; set; }
public virtual bool ResultResolved { get; set; }
public virtual string ResultType { get; set; }
public virtual DateTime DateUpdated { get; set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual List<SearchResultOfacAddress> Addresses { get; set; }
public virtual List<SearchResultOfacAka> Akas { get; set; }
public virtual List<SearchResultOfacDateOfBirth> DateOfBirths { get; set; }
public virtual List<SearchResultOfacNationality> Nationalities { get; set; }
public virtual List<SearchResultOfacPlaceOfBirth> PlaceOfBirths { get; set; }
}
public partial class SearchResultOfacAddress
{
public virtual string Address1 { get; set; }
public virtual string Address2 { get; set; }
public virtual string Address3 { get; set; }
public virtual string City { get; set; }
public virtual string State { get; set; }
public virtual string PostCode { get; set; }
public virtual string Country { get; set; }
}
public partial class SearchResultOfacAka
{
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string Type { get; set; }
public virtual string Strength { get; set; }
}
public partial class SearchResultOfacDateOfBirth
{
public virtual string DateOfBirth { get; set; }
}
public partial class SearchResultOfacNationality
{
public virtual string Country { get; set; }
}
public partial class SearchResultOfacPlaceOfBirth
{
public virtual string PlaceOfBirth { get; set; }
}
public partial class SearchResults
{
public SearchResults()
{
HMTResults = new List<SearchResultHmTreasury>{};
OfacResults = new List<SearchResultOfac>{};
}
public virtual List<SearchResultHmTreasury> HMTResults { get; set; }
public virtual List<SearchResultOfac> OfacResults { 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"}]}]}}}}