Sanctions Search API: v2

CountUpdatedSearches

Sanctions

The following routes are available for this service:
POST	/sanctions/updated/count	Get a count of sanctions searches affected by updates

import Foundation
import ServiceStack

// @DataContract
public class CountUpdatedSearches : BaseRequest
{
    // @DataMember
    public var request:CountUpdatedSearchesRequest

    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(CountUpdatedSearchesRequest.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 CountUpdatedSearchesRequest : Codable
{
    public var includeSearchesFromOtherUsers:Bool

    required public init(){}
}

// @DataContract
public class CountUpdatedSearchesResponse : Codable
{
    // @DataMember
    public var data:CountUpdatedSearchesData

    required public init(){}
}

public class CountUpdatedSearchesData : BaseResponse
{
    public var numberOfUpdatedSearches:Int

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

    private enum CodingKeys : String, CodingKey {
        case numberOfUpdatedSearches
    }

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

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

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

Swift CountUpdatedSearches 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 /sanctions/updated/count HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"includeSearchesFromOtherUsers":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"numberOfUpdatedSearches":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}