| Get all bulk searches |
import Foundation
import ServiceStack
// @DataContract
public class GetBulkSearchHistory : BaseRequest
{
// @DataMember
public var request:GetBulkSearchHistoryRequest
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(GetBulkSearchHistoryRequest.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 GetBulkSearchHistoryRequest : Codable
{
public var subUserName:String
public var page:Int
public var sortOrder:String
/**
* The user id to filter on, in string format (GUID)
*/
// @ApiMember(Description="The user id to filter on, in string format (GUID)")
public var whereUserId:String
public var whereDateFrom:Date?
public var whereDateTo:Date?
public var whereId:Int?
public var pageSize:Int
required public init(){}
}
// @DataContract
public class GetBulkSearchHistoryResponse : Codable
{
// @DataMember
public var data:GetBulkSearchHistoryData
required public init(){}
}
public class GetBulkSearchHistoryData : BaseResponse
{
public var bulkSearchList:ArrayOfBulkSearchStatus
public var currentPageNum:Int
public var maxPageNum:Int
public var totalBulkSearches:Int
public var pageSize:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case bulkSearchList
case currentPageNum
case maxPageNum
case totalBulkSearches
case pageSize
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
bulkSearchList = try container.decodeIfPresent(ArrayOfBulkSearchStatus.self, forKey: .bulkSearchList)
currentPageNum = try container.decodeIfPresent(Int.self, forKey: .currentPageNum)
maxPageNum = try container.decodeIfPresent(Int.self, forKey: .maxPageNum)
totalBulkSearches = try container.decodeIfPresent(Int.self, forKey: .totalBulkSearches)
pageSize = try container.decodeIfPresent(Int.self, forKey: .pageSize)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if bulkSearchList != nil { try container.encode(bulkSearchList, forKey: .bulkSearchList) }
if currentPageNum != nil { try container.encode(currentPageNum, forKey: .currentPageNum) }
if maxPageNum != nil { try container.encode(maxPageNum, forKey: .maxPageNum) }
if totalBulkSearches != nil { try container.encode(totalBulkSearches, forKey: .totalBulkSearches) }
if pageSize != nil { try container.encode(pageSize, forKey: .pageSize) }
}
}
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 ArrayOfBulkSearchStatus : List<BulkSearchStatus>
{
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 GetBulkSearchHistory DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetBulkSearchHistory
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetBulkSearchHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<WhereUserId>String</WhereUserId>
</Request>
</GetBulkSearchHistory>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetBulkSearchHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<BulkSearchList>
<BulkSearch>
<BulkSearchId>0</BulkSearchId>
<IsPepSearch>false</IsPepSearch>
<IsSanctionsSearch>false</IsSanctionsSearch>
<Message>String</Message>
<Processed>0</Processed>
<ProcessedPep>0</ProcessedPep>
<ProcessedSanctions>0</ProcessedSanctions>
<Status>String</Status>
<Success>false</Success>
<Total>0</Total>
<TotalPep>0</TotalPep>
<TotalSanctions>0</TotalSanctions>
</BulkSearch>
</BulkSearchList>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<PageSize>0</PageSize>
<TotalBulkSearches>0</TotalBulkSearches>
</Data>
</GetBulkSearchHistoryResponse>
</soap:Body>
</soap:Envelope>