Sanctions Search API: v2

<back to all web services

GetBulkSearchStatus

import Foundation
import ServiceStack

// @DataContract
public class GetBulkSearchStatus : BaseRequest
{
    // @DataMember
    public var request:GetBulkSearchStatusRequest

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case request
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        request = try container.decodeIfPresent(GetBulkSearchStatusRequest.self, forKey: .request)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if request != nil { try container.encode(request, forKey: .request) }
    }
}

// @DataContract
public class BaseRequest : IBaseRequest, Codable
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public var authentication:Authentication

    required public init(){}
}

// @DataContract
public class Authentication : Codable
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserId:String

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserKey:String

    required public init(){}
}

public class GetBulkSearchStatusRequest : Codable
{
    public var bulkSearchId:Int
    public var subUserName:String

    required public init(){}
}

// @DataContract
public class GetBulkSearchStatusResponse : Codable
{
    // @DataMember
    public var data:GetBulkSearchStatusData

    required public init(){}
}

public class GetBulkSearchStatusData : BaseResponse
{
    public var bulkSearchStatus:BulkSearchStatus

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case bulkSearchStatus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        bulkSearchStatus = try container.decodeIfPresent(BulkSearchStatus.self, forKey: .bulkSearchStatus)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if bulkSearchStatus != nil { try container.encode(bulkSearchStatus, forKey: .bulkSearchStatus) }
    }
}

public class BaseResponse : IBaseDataResponse, IHasResponseStatus, Codable
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class BulkSearchStatus : Codable
{
    public var bulkSearchId:Int
    public var success:Bool
    public var status:String
    public var total:Int
    public var message:String
    public var processed:Int
    public var isPepSearch:Bool
    public var isSanctionsSearch:Bool
    public var totalPep:Int
    public var processedPep:Int
    public var totalSanctions:Int
    public var processedSanctions:Int

    required public init(){}
}

Swift GetBulkSearchStatus DTOs

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"}}}}