POST | /searches/list | Get all sanctions searches |
---|
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 SearchListItem() =
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
[<AllowNullLiteral>]
type ArrayOfSearchListItem() =
inherit ResizeArray<SearchListItem>()
[<DataContract>]
[<AllowNullLiteral>]
type GetListSearchesData() =
[<DataMember>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataMember>]
member val TotalSearchRecords:Int32 = new Int32() with get,set
[<DataMember>]
member val CurrentPageNum:Int32 = new Int32() with get,set
[<DataMember>]
member val MaxPageNum:Int32 = new Int32() with get,set
[<DataMember>]
member val SearchRecords:ArrayOfSearchListItem = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetListSearchesResponse() =
[<DataMember>]
member val Data:GetListSearchesData = 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 GetListSearches() =
[<DataMember>]
member val Authentication:Authentication = null with get,set
[<DataMember>]
member val Page:Int32 = new Int32() with get,set
[<DataMember>]
member val SortOrder:String = null with get,set
[<DataMember>]
member val NameSearch:String = null 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 /searches/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Page":0,"SortOrder":"String","NameSearch":"String"}
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"}]},"TotalSearchRecords":0,"CurrentPageNum":0,"MaxPageNum":0,"SearchRecords":[{"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"}}]}}