| POST | /bulksearches/list | 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 .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 /bulksearches/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","page":0,"sortOrder":"String","whereUserId":"String","whereDateFrom":"\/Date(-62135596800000-0000)\/","whereDateTo":"\/Date(-62135596800000-0000)\/","whereId":0,"pageSize":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"bulkSearchList":[{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0}],"currentPageNum":0,"maxPageNum":0,"totalBulkSearches":0,"pageSize":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}