| POST | /sanctions/list | Get all sanctions searches |
|---|
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
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
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() 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
[<DataMember(Order=5)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///The status of the response
///</summary>
[<ApiMember(Description="The status of the response")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type SearchCriteria() =
member val Name:String = null with get,set
member val Address:String = null with get,set
member val Country:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Nationality:String = null with get,set
member val Reference:String = null with get,set
[<AllowNullLiteral>]
type SearchSource() =
member val ListId:String = null with get,set
member val ListName:String = null with get,set
member val ListShortName:String = null with get,set
member val IsAffectedByListUpdate:Nullable<Boolean> = new Nullable<Boolean>() 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 DateArchived:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val IsArchived:Boolean = new Boolean() 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 SearchSources:ResizeArray<SearchSource> = new ResizeArray<SearchSource>() with get,set
[<AllowNullLiteral>]
type ArrayOfSearchListItem() =
inherit ResizeArray<SearchListItem>()
[<AllowNullLiteral>]
type GetSearchesData() =
inherit BaseResponse()
member val TotalSearchRecords:Int32 = new Int32() with get,set
member val CurrentPageNum:Int32 = new Int32() with get,set
member val MaxPageNum:Int32 = new Int32() with get,set
member val SearchRecords:ArrayOfSearchListItem = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetSearchesResponse() =
[<DataMember>]
member val Data:GetSearchesData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Authentication() =
///<summary>
///The API User ID provided by us when you signed up to use our API
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
member val ApiUserId:String = null with get,set
///<summary>
///The API User Key provided by us when you signed up to use our API
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
member val ApiUserKey:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///The authentication credentials
///</summary>
[<DataMember>]
[<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
member val Authentication:Authentication = null with get,set
[<AllowNullLiteral>]
type GetSearchesRequest() =
///<summary>
///If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
///</summary>
[<ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")>]
member val SubUserName:String = null with get,set
member val ListUnresolvedSearches:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val ListUpdatedSearches:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val ListArchivedSearches:Boolean = new Boolean() with get,set
member val Page:Int32 = new Int32() with get,set
member val SortOrder:String = null with get,set
member val NameSearch:String = null with get,set
member val NameSearchExact:Boolean = new Boolean() with get,set
member val FilterReference:String = null with get,set
member val FilterType:String = null with get,set
member val FilterDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FilterDateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///If set, will only return searches created by the user
///</summary>
[<ApiMember(Description="If set, will only return searches created by the user")>]
member val FilterUserName:String = null with get,set
member val IncludeSearchSourcesFull:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetSearches() =
inherit BaseRequest()
[<DataMember>]
member val Request:GetSearchesRequest = 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 /sanctions/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","listUnresolvedSearches":false,"listUpdatedSearches":false,"listArchivedSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","nameSearchExact":false,"filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String","includeSearchSourcesFull":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"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"},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}