Sanctions Search API: v2

GetBulkSearchStatus

Bulk Search

The following routes are available for this service:
POST	/bulksearch/status	Get a bulk search status

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 GetBulkSearchStatusData() = 
        inherit BaseResponse()
        member val BulkSearchStatus:BulkSearchStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetBulkSearchStatusResponse() = 
        [<DataMember>]
        member val Data:GetBulkSearchStatusData = 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 GetBulkSearchStatusRequest() = 
        member val BulkSearchId:Int32 = new Int32() with get,set
        member val SubUserName:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetBulkSearchStatus() = 
        inherit BaseRequest()
        [<DataMember>]
        member val Request:GetBulkSearchStatusRequest = null with get,set

F# GetBulkSearchStatus DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /bulksearch/status HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"bulkSearchId":0,"subUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"bulkSearchStatus":{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}