Sanctions Search API: v2

<back to all web services

AddDbsSearch

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 LinkedTo implements IConvertible
{
    int? clientId;
    int? id;
    String? type;
    String? subtype;
    String? status;
    String? description;
    bool? isArchived;
    String? name;
    DateTime? date;

    LinkedTo({this.clientId,this.id,this.type,this.subtype,this.status,this.description,this.isArchived,this.name,this.date});
    LinkedTo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        clientId = json['clientId'];
        id = json['id'];
        type = json['type'];
        subtype = json['subtype'];
        status = json['status'];
        description = json['description'];
        isArchived = json['isArchived'];
        name = json['name'];
        date = JsonConverters.fromJson(json['date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'clientId': clientId,
        'id': id,
        'type': type,
        'subtype': subtype,
        'status': status,
        'description': description,
        'isArchived': isArchived,
        'name': name,
        'date': JsonConverters.toJson(date,'DateTime',context!)
    };

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

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

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

class ApplicantInformation implements IConvertible
{
    String? name;
    String? dateOfBirth;
    String? email;
    String? mobileInternational;
    String? jobLocation;
    String? reference;

    ApplicantInformation({this.name,this.dateOfBirth,this.email,this.mobileInternational,this.jobLocation,this.reference});
    ApplicantInformation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        dateOfBirth = json['dateOfBirth'];
        email = json['email'];
        mobileInternational = json['mobileInternational'];
        jobLocation = json['jobLocation'];
        reference = json['reference'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'dateOfBirth': dateOfBirth,
        'email': email,
        'mobileInternational': mobileInternational,
        'jobLocation': jobLocation,
        'reference': reference
    };

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

class DbsSearchSummary implements IConvertible
{
    int? id;
    DateTime? dateSearched;
    DateTime? dateUpdated;
    String? status;
    String? disclosureStatus;
    bool? isApplicantInfoCompleted;
    bool? isIdCheckCompleted;
    bool? isApplicationCompleted;
    bool? isApplicationSubmitted;
    bool? isApplicationDisclosed;
    String? disclosureLevel;
    ApplicantInformation? applicantInformation;

    DbsSearchSummary({this.id,this.dateSearched,this.dateUpdated,this.status,this.disclosureStatus,this.isApplicantInfoCompleted,this.isIdCheckCompleted,this.isApplicationCompleted,this.isApplicationSubmitted,this.isApplicationDisclosed,this.disclosureLevel,this.applicantInformation});
    DbsSearchSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        dateSearched = JsonConverters.fromJson(json['dateSearched'],'DateTime',context!);
        dateUpdated = JsonConverters.fromJson(json['dateUpdated'],'DateTime',context!);
        status = json['status'];
        disclosureStatus = json['disclosureStatus'];
        isApplicantInfoCompleted = json['isApplicantInfoCompleted'];
        isIdCheckCompleted = json['isIdCheckCompleted'];
        isApplicationCompleted = json['isApplicationCompleted'];
        isApplicationSubmitted = json['isApplicationSubmitted'];
        isApplicationDisclosed = json['isApplicationDisclosed'];
        disclosureLevel = json['disclosureLevel'];
        applicantInformation = JsonConverters.fromJson(json['applicantInformation'],'ApplicantInformation',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'dateSearched': JsonConverters.toJson(dateSearched,'DateTime',context!),
        'dateUpdated': JsonConverters.toJson(dateUpdated,'DateTime',context!),
        'status': status,
        'disclosureStatus': disclosureStatus,
        'isApplicantInfoCompleted': isApplicantInfoCompleted,
        'isIdCheckCompleted': isIdCheckCompleted,
        'isApplicationCompleted': isApplicationCompleted,
        'isApplicationSubmitted': isApplicationSubmitted,
        'isApplicationDisclosed': isApplicationDisclosed,
        'disclosureLevel': disclosureLevel,
        'applicantInformation': JsonConverters.toJson(applicantInformation,'ApplicantInformation',context!)
    };

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

class AddDbsSearchData extends BaseResponse implements IBaseSearchResponse, IConvertible
{
    ArrayOfLinkedTo? linkedTo;
    DbsSearchSummary? summary;

    AddDbsSearchData({this.linkedTo,this.summary});
    AddDbsSearchData.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'linkedTo': JsonConverters.toJson(linkedTo,'ArrayOfLinkedTo',context!),
        'summary': JsonConverters.toJson(summary,'DbsSearchSummary',context!)
    });

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

// @DataContract
class AddDbsSearchResponse implements IConvertible
{
    // @DataMember
    AddDbsSearchData? data;

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

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

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

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

class AddDbsSearchRequest implements IConvertible
{
    /**
    * The full name of the applicant
    */
    // @ApiMember(Description="The full name of the applicant", IsRequired=true)
    String? name;

    /**
    * The date of birth for the applicant (DD/MM/YYYY format)
    */
    // @ApiMember(Description="The date of birth for the applicant (DD/MM/YYYY format)", IsRequired=true)
    String? dateOfBirth;

    /**
    * The email address of the applicant
    */
    // @ApiMember(Description="The email address of the applicant", IsRequired=true)
    String? email;

    /**
    * The applicant's mobile phone number in international format (e.g. '+447123456789')
    */
    // @ApiMember(Description="The applicant's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)
    String? mobileInternational;

    /**
    * The country where the job is located
    */
    // @ApiMember(Description="The country where the job is located", IsRequired=true)
    String? jobLocation;

    /**
    * The disclosure level of the DBS required
    */
    // @ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)
    String? disclosureLevel;

    /**
    * Your reference, if any
    */
    // @ApiMember(Description="Your reference, if any")
    String? reference;

    /**
    * If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account
    */
    // @ApiMember(Description="If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account")
    String? subUserName;

    /**
    * If the search should be linked to other searches, specify the them here
    */
    // @ApiMember(Description="If the search should be linked to other searches, specify the them here")
    ArrayOfLinkedTo? linkedTo;

    AddDbsSearchRequest({this.name,this.dateOfBirth,this.email,this.mobileInternational,this.jobLocation,this.disclosureLevel,this.reference,this.subUserName,this.linkedTo});
    AddDbsSearchRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        dateOfBirth = json['dateOfBirth'];
        email = json['email'];
        mobileInternational = json['mobileInternational'];
        jobLocation = json['jobLocation'];
        disclosureLevel = json['disclosureLevel'];
        reference = json['reference'];
        subUserName = json['subUserName'];
        linkedTo = JsonConverters.fromJson(json['linkedTo'],'ArrayOfLinkedTo',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'dateOfBirth': dateOfBirth,
        'email': email,
        'mobileInternational': mobileInternational,
        'jobLocation': jobLocation,
        'disclosureLevel': disclosureLevel,
        'reference': reference,
        'subUserName': subUserName,
        'linkedTo': JsonConverters.toJson(linkedTo,'ArrayOfLinkedTo',context!)
    };

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

// @DataContract
class AddDbsSearch extends BaseRequest implements IConvertible
{
    // @DataMember
    AddDbsSearchRequest? request;

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

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

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

    getTypeName() => "AddDbsSearch";
    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()),
    'LinkedTo': TypeInfo(TypeOf.Class, create:() => LinkedTo()),
    'ArrayOfLinkedTo': TypeInfo(TypeOf.Class, create:() => ArrayOfLinkedTo()),
    'ApplicantInformation': TypeInfo(TypeOf.Class, create:() => ApplicantInformation()),
    'DbsSearchSummary': TypeInfo(TypeOf.Class, create:() => DbsSearchSummary()),
    'AddDbsSearchData': TypeInfo(TypeOf.Class, create:() => AddDbsSearchData()),
    'AddDbsSearchResponse': TypeInfo(TypeOf.Class, create:() => AddDbsSearchResponse()),
    'AddDbsSearchRequest': TypeInfo(TypeOf.Class, create:() => AddDbsSearchRequest()),
    'AddDbsSearch': TypeInfo(TypeOf.Class, create:() => AddDbsSearch()),
});

Dart AddDbsSearch DTOs

POST /dbs HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddDbsSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <DateOfBirth>String</DateOfBirth>
    <DisclosureLevel>String</DisclosureLevel>
    <Email>String</Email>
    <JobLocation>String</JobLocation>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <MobileInternational>String</MobileInternational>
    <Name>String</Name>
    <Reference>String</Reference>
    <SubUserName>String</SubUserName>
  </Request>
</AddDbsSearch>

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

<AddDbsSearchResponse 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>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <Summary>
      <ApplicantInformation>
        <DateOfBirth>String</DateOfBirth>
        <Email>String</Email>
        <JobLocation>String</JobLocation>
        <MobileInternational>String</MobileInternational>
        <Name>String</Name>
        <Reference>String</Reference>
      </ApplicantInformation>
      <DateSearched>0001-01-01T00:00:00</DateSearched>
      <DateUpdated>0001-01-01T00:00:00</DateUpdated>
      <DisclosureLevel>String</DisclosureLevel>
      <DisclosureStatus>String</DisclosureStatus>
      <Id>0</Id>
      <IsApplicantInfoCompleted>false</IsApplicantInfoCompleted>
      <IsApplicationCompleted>false</IsApplicationCompleted>
      <IsApplicationDisclosed>false</IsApplicationDisclosed>
      <IsApplicationSubmitted>false</IsApplicationSubmitted>
      <IsIdCheckCompleted>false</IsIdCheckCompleted>
      <Status>String</Status>
    </Summary>
  </Data>
</AddDbsSearchResponse>