| POST | /sanctions/list | Get all sanctions 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 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 SearchSource implements IConvertible
{
String? listId;
String? listName;
String? listShortName;
bool? isAffectedByListUpdate;
SearchSource({this.listId,this.listName,this.listShortName,this.isAffectedByListUpdate});
SearchSource.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
listId = json['listId'];
listName = json['listName'];
listShortName = json['listShortName'];
isAffectedByListUpdate = json['isAffectedByListUpdate'];
return this;
}
Map<String, dynamic> toJson() => {
'listId': listId,
'listName': listName,
'listShortName': listShortName,
'isAffectedByListUpdate': isAffectedByListUpdate
};
getTypeName() => "SearchSource";
TypeContext? context = _ctx;
}
class SearchListItem implements IConvertible
{
int? id;
String? searchType;
DateTime? dateSearched;
DateTime? dateUpdated;
DateTime? dateArchived;
bool? isArchived;
int? numOfResults;
bool? clientInResults;
bool? clientNotInResults;
bool? affectedByUpdate;
SearchCriteria? searchCriteria;
List<SearchSource>? searchSources;
SearchListItem({this.id,this.searchType,this.dateSearched,this.dateUpdated,this.dateArchived,this.isArchived,this.numOfResults,this.clientInResults,this.clientNotInResults,this.affectedByUpdate,this.searchCriteria,this.searchSources});
SearchListItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
searchType = json['searchType'];
dateSearched = JsonConverters.fromJson(json['dateSearched'],'DateTime',context!);
dateUpdated = JsonConverters.fromJson(json['dateUpdated'],'DateTime',context!);
dateArchived = JsonConverters.fromJson(json['dateArchived'],'DateTime',context!);
isArchived = json['isArchived'];
numOfResults = json['numOfResults'];
clientInResults = json['clientInResults'];
clientNotInResults = json['clientNotInResults'];
affectedByUpdate = json['affectedByUpdate'];
searchCriteria = JsonConverters.fromJson(json['searchCriteria'],'SearchCriteria',context!);
searchSources = JsonConverters.fromJson(json['searchSources'],'List<SearchSource>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'searchType': searchType,
'dateSearched': JsonConverters.toJson(dateSearched,'DateTime',context!),
'dateUpdated': JsonConverters.toJson(dateUpdated,'DateTime',context!),
'dateArchived': JsonConverters.toJson(dateArchived,'DateTime',context!),
'isArchived': isArchived,
'numOfResults': numOfResults,
'clientInResults': clientInResults,
'clientNotInResults': clientNotInResults,
'affectedByUpdate': affectedByUpdate,
'searchCriteria': JsonConverters.toJson(searchCriteria,'SearchCriteria',context!),
'searchSources': JsonConverters.toJson(searchSources,'List<SearchSource>',context!)
};
getTypeName() => "SearchListItem";
TypeContext? context = _ctx;
}
class ArrayOfSearchListItem extends ListBase<SearchListItem> implements IConvertible
{
final List<SearchListItem> l = [];
set length(int newLength) { l.length = newLength; }
int get length => l.length;
SearchListItem operator [](int index) => l[index];
void operator []=(int index, SearchListItem value) { l[index] = value; }
ArrayOfSearchListItem();
ArrayOfSearchListItem.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "ArrayOfSearchListItem";
TypeContext? context = _ctx;
}
class GetSearchesData extends BaseResponse implements IConvertible
{
int? totalSearchRecords;
int? currentPageNum;
int? maxPageNum;
ArrayOfSearchListItem? searchRecords;
GetSearchesData({this.totalSearchRecords,this.currentPageNum,this.maxPageNum,this.searchRecords});
GetSearchesData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
totalSearchRecords = json['totalSearchRecords'];
currentPageNum = json['currentPageNum'];
maxPageNum = json['maxPageNum'];
searchRecords = JsonConverters.fromJson(json['searchRecords'],'ArrayOfSearchListItem',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'totalSearchRecords': totalSearchRecords,
'currentPageNum': currentPageNum,
'maxPageNum': maxPageNum,
'searchRecords': JsonConverters.toJson(searchRecords,'ArrayOfSearchListItem',context!)
});
getTypeName() => "GetSearchesData";
TypeContext? context = _ctx;
}
// @DataContract
class GetSearchesResponse implements IConvertible
{
// @DataMember
GetSearchesData? data;
GetSearchesResponse({this.data});
GetSearchesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
data = JsonConverters.fromJson(json['data'],'GetSearchesData',context!);
return this;
}
Map<String, dynamic> toJson() => {
'data': JsonConverters.toJson(data,'GetSearchesData',context!)
};
getTypeName() => "GetSearchesResponse";
TypeContext? context = _ctx;
}
class GetSearchesRequest 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? listUnresolvedSearches;
bool? listUpdatedSearches;
bool? listArchivedSearches;
int? page;
String? sortOrder;
String? nameSearch;
bool? nameSearchExact;
String? filterReference;
String? filterType;
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;
bool? includeSearchSourcesFull;
GetSearchesRequest({this.subUserName,this.listUnresolvedSearches,this.listUpdatedSearches,this.listArchivedSearches,this.page,this.sortOrder,this.nameSearch,this.nameSearchExact,this.filterReference,this.filterType,this.filterDateFrom,this.filterDateTo,this.filterUserName,this.includeSearchSourcesFull});
GetSearchesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
subUserName = json['subUserName'];
listUnresolvedSearches = json['listUnresolvedSearches'];
listUpdatedSearches = json['listUpdatedSearches'];
listArchivedSearches = json['listArchivedSearches'];
page = json['page'];
sortOrder = json['sortOrder'];
nameSearch = json['nameSearch'];
nameSearchExact = json['nameSearchExact'];
filterReference = json['filterReference'];
filterType = json['filterType'];
filterDateFrom = JsonConverters.fromJson(json['filterDateFrom'],'DateTime',context!);
filterDateTo = JsonConverters.fromJson(json['filterDateTo'],'DateTime',context!);
filterUserName = json['filterUserName'];
includeSearchSourcesFull = json['includeSearchSourcesFull'];
return this;
}
Map<String, dynamic> toJson() => {
'subUserName': subUserName,
'listUnresolvedSearches': listUnresolvedSearches,
'listUpdatedSearches': listUpdatedSearches,
'listArchivedSearches': listArchivedSearches,
'page': page,
'sortOrder': sortOrder,
'nameSearch': nameSearch,
'nameSearchExact': nameSearchExact,
'filterReference': filterReference,
'filterType': filterType,
'filterDateFrom': JsonConverters.toJson(filterDateFrom,'DateTime',context!),
'filterDateTo': JsonConverters.toJson(filterDateTo,'DateTime',context!),
'filterUserName': filterUserName,
'includeSearchSourcesFull': includeSearchSourcesFull
};
getTypeName() => "GetSearchesRequest";
TypeContext? context = _ctx;
}
// @DataContract
class GetSearches extends BaseRequest implements IConvertible
{
// @DataMember
GetSearchesRequest? request;
GetSearches({this.request});
GetSearches.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
request = JsonConverters.fromJson(json['request'],'GetSearchesRequest',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'request': JsonConverters.toJson(request,'GetSearchesRequest',context!)
});
getTypeName() => "GetSearches";
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()),
'SearchSource': TypeInfo(TypeOf.Class, create:() => SearchSource()),
'SearchListItem': TypeInfo(TypeOf.Class, create:() => SearchListItem()),
'List<SearchSource>': TypeInfo(TypeOf.Class, create:() => <SearchSource>[]),
'ArrayOfSearchListItem': TypeInfo(TypeOf.Class, create:() => ArrayOfSearchListItem()),
'GetSearchesData': TypeInfo(TypeOf.Class, create:() => GetSearchesData()),
'GetSearchesResponse': TypeInfo(TypeOf.Class, create:() => GetSearchesResponse()),
'GetSearchesRequest': TypeInfo(TypeOf.Class, create:() => GetSearchesRequest()),
'GetSearches': TypeInfo(TypeOf.Class, create:() => GetSearches()),
});
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"}}}}