Sanctions Search API: v2

<back to all web services

GetCompanyLookups

CompanyLookup
The following routes are available for this service:
POST/companylookups/listGet all company lookups
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 SearchCriteria implements IConvertible
{
    String? name;
    String? address;
    String? country;
    String? dateOfBirth;
    String? nationality;
    String? reference;

    SearchCriteria({this.name,this.address,this.country,this.dateOfBirth,this.nationality,this.reference});
    SearchCriteria.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        address = json['address'];
        country = json['country'];
        dateOfBirth = json['dateOfBirth'];
        nationality = json['nationality'];
        reference = json['reference'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'address': address,
        'country': country,
        'dateOfBirth': dateOfBirth,
        'nationality': nationality,
        'reference': reference
    };

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

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

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

class CompanyLookupListItem implements IConvertible
{
    int? id;
    SearchCriteria? searchCriteria;
    ArrayOfLists? selectedLists;
    DateTime? date;
    bool? hasCompanyId;
    bool? hasCompanyDetails;
    bool? hasStartedSearches;
    bool? hasCompletedSearches;

    CompanyLookupListItem({this.id,this.searchCriteria,this.selectedLists,this.date,this.hasCompanyId,this.hasCompanyDetails,this.hasStartedSearches,this.hasCompletedSearches});
    CompanyLookupListItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        searchCriteria = JsonConverters.fromJson(json['searchCriteria'],'SearchCriteria',context!);
        selectedLists = JsonConverters.fromJson(json['selectedLists'],'ArrayOfLists',context!);
        date = JsonConverters.fromJson(json['date'],'DateTime',context!);
        hasCompanyId = json['hasCompanyId'];
        hasCompanyDetails = json['hasCompanyDetails'];
        hasStartedSearches = json['hasStartedSearches'];
        hasCompletedSearches = json['hasCompletedSearches'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'searchCriteria': JsonConverters.toJson(searchCriteria,'SearchCriteria',context!),
        'selectedLists': JsonConverters.toJson(selectedLists,'ArrayOfLists',context!),
        'date': JsonConverters.toJson(date,'DateTime',context!),
        'hasCompanyId': hasCompanyId,
        'hasCompanyDetails': hasCompanyDetails,
        'hasStartedSearches': hasStartedSearches,
        'hasCompletedSearches': hasCompletedSearches
    };

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

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

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

class GetCompanyLookupsData extends BaseResponse implements IConvertible
{
    int? totalRecords;
    int? currentPageNum;
    int? maxPageNum;
    ArrayOfCompanyLookupListItem? companyLookupRecords;

    GetCompanyLookupsData({this.totalRecords,this.currentPageNum,this.maxPageNum,this.companyLookupRecords});
    GetCompanyLookupsData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        totalRecords = json['totalRecords'];
        currentPageNum = json['currentPageNum'];
        maxPageNum = json['maxPageNum'];
        companyLookupRecords = JsonConverters.fromJson(json['companyLookupRecords'],'ArrayOfCompanyLookupListItem',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'totalRecords': totalRecords,
        'currentPageNum': currentPageNum,
        'maxPageNum': maxPageNum,
        'companyLookupRecords': JsonConverters.toJson(companyLookupRecords,'ArrayOfCompanyLookupListItem',context!)
    });

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

// @DataContract
class GetCompanyLookupsResponse implements IConvertible
{
    // @DataMember
    GetCompanyLookupsData? data;

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

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

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

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

class GetCompanyLookupsRequest implements IConvertible
{
    /**
    * 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")
    String? subUserName;

    bool? listIncompleteSearches;
    int? page;
    String? sortOrder;
    String? nameSearch;
    String? filterReference;
    DateTime? filterDateFrom;
    DateTime? filterDateTo;
    /**
    * If set, will only return searches created by the user
    */
    // @ApiMember(Description="If set, will only return searches created by the user")
    String? filterUserName;

    GetCompanyLookupsRequest({this.subUserName,this.listIncompleteSearches,this.page,this.sortOrder,this.nameSearch,this.filterReference,this.filterDateFrom,this.filterDateTo,this.filterUserName});
    GetCompanyLookupsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        subUserName = json['subUserName'];
        listIncompleteSearches = json['listIncompleteSearches'];
        page = json['page'];
        sortOrder = json['sortOrder'];
        nameSearch = json['nameSearch'];
        filterReference = json['filterReference'];
        filterDateFrom = JsonConverters.fromJson(json['filterDateFrom'],'DateTime',context!);
        filterDateTo = JsonConverters.fromJson(json['filterDateTo'],'DateTime',context!);
        filterUserName = json['filterUserName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'subUserName': subUserName,
        'listIncompleteSearches': listIncompleteSearches,
        'page': page,
        'sortOrder': sortOrder,
        'nameSearch': nameSearch,
        'filterReference': filterReference,
        'filterDateFrom': JsonConverters.toJson(filterDateFrom,'DateTime',context!),
        'filterDateTo': JsonConverters.toJson(filterDateTo,'DateTime',context!),
        'filterUserName': filterUserName
    };

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

// @DataContract
class GetCompanyLookups extends BaseRequest implements IConvertible
{
    // @DataMember
    GetCompanyLookupsRequest? request;

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

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

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

    getTypeName() => "GetCompanyLookups";
    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()),
    'SearchCriteria': TypeInfo(TypeOf.Class, create:() => SearchCriteria()),
    'ArrayOfLists': TypeInfo(TypeOf.Class, create:() => ArrayOfLists()),
    'CompanyLookupListItem': TypeInfo(TypeOf.Class, create:() => CompanyLookupListItem()),
    'ArrayOfCompanyLookupListItem': TypeInfo(TypeOf.Class, create:() => ArrayOfCompanyLookupListItem()),
    'GetCompanyLookupsData': TypeInfo(TypeOf.Class, create:() => GetCompanyLookupsData()),
    'GetCompanyLookupsResponse': TypeInfo(TypeOf.Class, create:() => GetCompanyLookupsResponse()),
    'GetCompanyLookupsRequest': TypeInfo(TypeOf.Class, create:() => GetCompanyLookupsRequest()),
    'GetCompanyLookups': TypeInfo(TypeOf.Class, create:() => GetCompanyLookups()),
});

Dart GetCompanyLookups 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 /companylookups/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","listIncompleteSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","filterReference":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"totalRecords":0,"currentPageNum":0,"maxPageNum":0,"companyLookupRecords":[{"id":0,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"selectedLists":["String"],"date":"\/Date(-62135596800000-0000)\/","hasCompanyId":false,"hasCompanyDetails":false,"hasStartedSearches":false,"hasCompletedSearches":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}