| POST | /sanctions/list | Get all sanctions searches |
|---|
import Foundation
import ServiceStack
// @DataContract
public class GetSearches : BaseRequest
{
// @DataMember
public var request:GetSearchesRequest
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(GetSearchesRequest.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 GetSearchesRequest : Codable
{
/**
* If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
*/
// @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")
public var subUserName:String
public var listUnresolvedSearches:Bool?
public var listUpdatedSearches:Bool?
public var listArchivedSearches:Bool
public var page:Int
public var sortOrder:String
public var nameSearch:String
public var nameSearchExact:Bool
public var filterReference:String
public var filterType:String
public var filterDateFrom:Date?
public var filterDateTo:Date?
/**
* If set, will only return searches created by the user
*/
// @ApiMember(Description="If set, will only return searches created by the user")
public var filterUserName:String
public var includeSearchSourcesFull:Bool
required public init(){}
}
// @DataContract
public class GetSearchesResponse : Codable
{
// @DataMember
public var data:GetSearchesData
required public init(){}
}
public class GetSearchesData : BaseResponse
{
public var totalSearchRecords:Int
public var currentPageNum:Int
public var maxPageNum:Int
public var searchRecords:ArrayOfSearchListItem
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case totalSearchRecords
case currentPageNum
case maxPageNum
case searchRecords
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
totalSearchRecords = try container.decodeIfPresent(Int.self, forKey: .totalSearchRecords)
currentPageNum = try container.decodeIfPresent(Int.self, forKey: .currentPageNum)
maxPageNum = try container.decodeIfPresent(Int.self, forKey: .maxPageNum)
searchRecords = try container.decodeIfPresent(ArrayOfSearchListItem.self, forKey: .searchRecords)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if totalSearchRecords != nil { try container.encode(totalSearchRecords, forKey: .totalSearchRecords) }
if currentPageNum != nil { try container.encode(currentPageNum, forKey: .currentPageNum) }
if maxPageNum != nil { try container.encode(maxPageNum, forKey: .maxPageNum) }
if searchRecords != nil { try container.encode(searchRecords, forKey: .searchRecords) }
}
}
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 ArrayOfSearchListItem : List<SearchListItem>
{
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 SearchListItem : Codable
{
public var id:Int
public var searchType:String
public var dateSearched:Date
public var dateUpdated:Date
public var dateArchived:Date?
public var isArchived:Bool
public var numOfResults:Int
public var clientInResults:Bool
public var clientNotInResults:Bool
public var affectedByUpdate:Bool
public var searchCriteria:SearchCriteria
public var searchSources:[SearchSource] = []
required public init(){}
}
public class SearchCriteria : Codable
{
public var name:String
public var address:String
public var country:String
public var dateOfBirth:String
public var nationality:String
public var reference:String
required public init(){}
}
public class SearchSource : Codable
{
public var listId:String
public var listName:String
public var listShortName:String
public var isAffectedByListUpdate:Bool?
required public init(){}
}
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"}}}}