| POST | /bulksearches/list | Get all bulk 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 BulkSearchStatus() =
member val BulkSearchId:Int32 = new Int32() with get,set
member val Success:Boolean = new Boolean() with get,set
member val Status:String = null with get,set
member val Total:Int32 = new Int32() with get,set
member val Message:String = null with get,set
member val Processed:Int32 = new Int32() with get,set
member val IsPepSearch:Boolean = new Boolean() with get,set
member val IsSanctionsSearch:Boolean = new Boolean() with get,set
member val TotalPep:Int32 = new Int32() with get,set
member val ProcessedPep:Int32 = new Int32() with get,set
member val TotalSanctions:Int32 = new Int32() with get,set
member val ProcessedSanctions:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ArrayOfBulkSearchStatus() =
inherit ResizeArray<BulkSearchStatus>()
[<AllowNullLiteral>]
type GetBulkSearchHistoryData() =
inherit BaseResponse()
member val BulkSearchList:ArrayOfBulkSearchStatus = null with get,set
member val CurrentPageNum:Int32 = new Int32() with get,set
member val MaxPageNum:Int32 = new Int32() with get,set
member val TotalBulkSearches:Int32 = new Int32() with get,set
member val PageSize:Int32 = new Int32() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetBulkSearchHistoryResponse() =
[<DataMember>]
member val Data:GetBulkSearchHistoryData = 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 GetBulkSearchHistoryRequest() =
member val SubUserName:String = null with get,set
member val Page:Int32 = new Int32() with get,set
member val SortOrder:String = null with get,set
///<summary>
///The user id to filter on, in string format (GUID)
///</summary>
[<ApiMember(Description="The user id to filter on, in string format (GUID)")>]
member val WhereUserId:String = null with get,set
member val WhereDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val WhereDateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val WhereId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PageSize:Int32 = new Int32() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetBulkSearchHistory() =
inherit BaseRequest()
[<DataMember>]
member val Request:GetBulkSearchHistoryRequest = 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 /bulksearches/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","page":0,"sortOrder":"String","whereUserId":"String","whereDateFrom":"\/Date(-62135596800000-0000)\/","whereDateTo":"\/Date(-62135596800000-0000)\/","whereId":0,"pageSize":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"bulkSearchList":[{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0}],"currentPageNum":0,"maxPageNum":0,"totalBulkSearches":0,"pageSize":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}