Sanctions Search API: v2

<back to all web services

GetBulkSearchHistory

Get all bulk searches
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
class Authentication implements IConvertible
{
    /**
    * 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")
    String? apiUserId;

    /**
    * 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")
    String? apiUserKey;

    Authentication({this.apiUserId,this.apiUserKey});
    Authentication.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiUserId = json['apiUserId'];
        apiUserKey = json['apiUserKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiUserId': apiUserId,
        'apiUserKey': apiUserKey
    };

    getTypeName() => "Authentication";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseRequest implements IBaseRequest, IConvertible
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    Authentication? authentication;

    BaseRequest({this.authentication});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        authentication = JsonConverters.fromJson(json['authentication'],'Authentication',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'authentication': JsonConverters.toJson(authentication,'Authentication',context!)
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class ResponseError implements IConvertible
{
    // @DataMember(Order=1)
    String? errorCode;

    // @DataMember(Order=2)
    String? fieldName;

    // @DataMember(Order=3)
    String? message;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    ResponseError({this.errorCode,this.fieldName,this.message,this.meta});
    ResponseError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        errorCode = json['errorCode'];
        fieldName = json['fieldName'];
        message = json['message'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'errorCode': errorCode,
        'fieldName': fieldName,
        'message': message,
        'meta': meta
    };

    getTypeName() => "ResponseError";
    TypeContext? context = _ctx;
}

class ArrayOfResponseError extends ListBase<ResponseError> implements IConvertible
{
    final List<ResponseError> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    ResponseError operator [](int index) => l[index];
    void operator []=(int index, ResponseError value) { l[index] = value; }
    ArrayOfResponseError();
    ArrayOfResponseError.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ArrayOfResponseError";
    TypeContext? context = _ctx;
}

// @DataContract
class ResponseStatus implements IConvertible
{
    // @DataMember(Order=1)
    String? errorCode;

    // @DataMember(Order=2)
    String? message;

    // @DataMember(Order=3)
    String? stackTrace;

    // @DataMember(Order=4)
    ArrayOfResponseError? errors;

    // @DataMember(Order=5)
    Map<String,String?>? meta;

    ResponseStatus({this.errorCode,this.message,this.stackTrace,this.errors,this.meta});
    ResponseStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        errorCode = json['errorCode'];
        message = json['message'];
        stackTrace = json['stackTrace'];
        errors = JsonConverters.fromJson(json['errors'],'ArrayOfResponseError',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'errorCode': errorCode,
        'message': message,
        'stackTrace': stackTrace,
        'errors': JsonConverters.toJson(errors,'ArrayOfResponseError',context!),
        'meta': meta
    };

    getTypeName() => "ResponseStatus";
    TypeContext? context = _ctx;
}

class BaseResponse implements IBaseDataResponse, IHasResponseStatus, IConvertible
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    ResponseStatus? responseStatus;

    BaseResponse({this.responseStatus});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

class BulkSearchStatus implements IConvertible
{
    int? bulkSearchId;
    bool? success;
    String? status;
    int? total;
    String? message;
    int? processed;
    bool? isPepSearch;
    bool? isSanctionsSearch;
    int? totalPep;
    int? processedPep;
    int? totalSanctions;
    int? processedSanctions;

    BulkSearchStatus({this.bulkSearchId,this.success,this.status,this.total,this.message,this.processed,this.isPepSearch,this.isSanctionsSearch,this.totalPep,this.processedPep,this.totalSanctions,this.processedSanctions});
    BulkSearchStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        bulkSearchId = json['bulkSearchId'];
        success = json['success'];
        status = json['status'];
        total = json['total'];
        message = json['message'];
        processed = json['processed'];
        isPepSearch = json['isPepSearch'];
        isSanctionsSearch = json['isSanctionsSearch'];
        totalPep = json['totalPep'];
        processedPep = json['processedPep'];
        totalSanctions = json['totalSanctions'];
        processedSanctions = json['processedSanctions'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'bulkSearchId': bulkSearchId,
        'success': success,
        'status': status,
        'total': total,
        'message': message,
        'processed': processed,
        'isPepSearch': isPepSearch,
        'isSanctionsSearch': isSanctionsSearch,
        'totalPep': totalPep,
        'processedPep': processedPep,
        'totalSanctions': totalSanctions,
        'processedSanctions': processedSanctions
    };

    getTypeName() => "BulkSearchStatus";
    TypeContext? context = _ctx;
}

class ArrayOfBulkSearchStatus extends ListBase<BulkSearchStatus> implements IConvertible
{
    final List<BulkSearchStatus> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    BulkSearchStatus operator [](int index) => l[index];
    void operator []=(int index, BulkSearchStatus value) { l[index] = value; }
    ArrayOfBulkSearchStatus();
    ArrayOfBulkSearchStatus.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ArrayOfBulkSearchStatus";
    TypeContext? context = _ctx;
}

class GetBulkSearchHistoryData extends BaseResponse implements IConvertible
{
    ArrayOfBulkSearchStatus? bulkSearchList;
    int? currentPageNum;
    int? maxPageNum;
    int? totalBulkSearches;
    int? pageSize;

    GetBulkSearchHistoryData({this.bulkSearchList,this.currentPageNum,this.maxPageNum,this.totalBulkSearches,this.pageSize});
    GetBulkSearchHistoryData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        bulkSearchList = JsonConverters.fromJson(json['bulkSearchList'],'ArrayOfBulkSearchStatus',context!);
        currentPageNum = json['currentPageNum'];
        maxPageNum = json['maxPageNum'];
        totalBulkSearches = json['totalBulkSearches'];
        pageSize = json['pageSize'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'bulkSearchList': JsonConverters.toJson(bulkSearchList,'ArrayOfBulkSearchStatus',context!),
        'currentPageNum': currentPageNum,
        'maxPageNum': maxPageNum,
        'totalBulkSearches': totalBulkSearches,
        'pageSize': pageSize
    });

    getTypeName() => "GetBulkSearchHistoryData";
    TypeContext? context = _ctx;
}

// @DataContract
class GetBulkSearchHistoryResponse implements IConvertible
{
    // @DataMember
    GetBulkSearchHistoryData? data;

    GetBulkSearchHistoryResponse({this.data});
    GetBulkSearchHistoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        data = JsonConverters.fromJson(json['data'],'GetBulkSearchHistoryData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'data': JsonConverters.toJson(data,'GetBulkSearchHistoryData',context!)
    };

    getTypeName() => "GetBulkSearchHistoryResponse";
    TypeContext? context = _ctx;
}

class GetBulkSearchHistoryRequest implements IConvertible
{
    String? subUserName;
    int? page;
    String? sortOrder;
    /**
    * The user id to filter on, in string format (GUID)
    */
    // @ApiMember(Description="The user id to filter on, in string format (GUID)")
    String? whereUserId;

    DateTime? whereDateFrom;
    DateTime? whereDateTo;
    int? whereId;
    int? pageSize;

    GetBulkSearchHistoryRequest({this.subUserName,this.page,this.sortOrder,this.whereUserId,this.whereDateFrom,this.whereDateTo,this.whereId,this.pageSize});
    GetBulkSearchHistoryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        subUserName = json['subUserName'];
        page = json['page'];
        sortOrder = json['sortOrder'];
        whereUserId = json['whereUserId'];
        whereDateFrom = JsonConverters.fromJson(json['whereDateFrom'],'DateTime',context!);
        whereDateTo = JsonConverters.fromJson(json['whereDateTo'],'DateTime',context!);
        whereId = json['whereId'];
        pageSize = json['pageSize'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'subUserName': subUserName,
        'page': page,
        'sortOrder': sortOrder,
        'whereUserId': whereUserId,
        'whereDateFrom': JsonConverters.toJson(whereDateFrom,'DateTime',context!),
        'whereDateTo': JsonConverters.toJson(whereDateTo,'DateTime',context!),
        'whereId': whereId,
        'pageSize': pageSize
    };

    getTypeName() => "GetBulkSearchHistoryRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class GetBulkSearchHistory extends BaseRequest implements IConvertible
{
    // @DataMember
    GetBulkSearchHistoryRequest? request;

    GetBulkSearchHistory({this.request});
    GetBulkSearchHistory.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        request = JsonConverters.fromJson(json['request'],'GetBulkSearchHistoryRequest',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'request': JsonConverters.toJson(request,'GetBulkSearchHistoryRequest',context!)
    });

    getTypeName() => "GetBulkSearchHistory";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.sanctionssearch.com', types: <String, TypeInfo> {
    'Authentication': TypeInfo(TypeOf.Class, create:() => Authentication()),
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'ArrayOfResponseError': TypeInfo(TypeOf.Class, create:() => ArrayOfResponseError()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'BulkSearchStatus': TypeInfo(TypeOf.Class, create:() => BulkSearchStatus()),
    'ArrayOfBulkSearchStatus': TypeInfo(TypeOf.Class, create:() => ArrayOfBulkSearchStatus()),
    'GetBulkSearchHistoryData': TypeInfo(TypeOf.Class, create:() => GetBulkSearchHistoryData()),
    'GetBulkSearchHistoryResponse': TypeInfo(TypeOf.Class, create:() => GetBulkSearchHistoryResponse()),
    'GetBulkSearchHistoryRequest': TypeInfo(TypeOf.Class, create:() => GetBulkSearchHistoryRequest()),
    'GetBulkSearchHistory': TypeInfo(TypeOf.Class, create:() => GetBulkSearchHistory()),
});

Dart GetBulkSearchHistory DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + 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>