Sanctions Search API: v2

<back to all web services

AddBulkSearch

// @DataContract
export class Authentication
{
    /** @description 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")
    public apiUserId: string;

    /** @description 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")
    public apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class BulkSearchStatus
{
    public bulkSearchId: number;
    public success: boolean;
    public status: string;
    public total: number;
    public message: string;
    public processed: number;
    public isPepSearch: boolean;
    public isSanctionsSearch: boolean;
    public totalPep: number;
    public processedPep: number;
    public totalSanctions: number;
    public processedSanctions: number;

    public constructor(init?: Partial<BulkSearchStatus>) { (Object as any).assign(this, init); }
}

export class AddBulkSearchData extends BaseResponse
{
    public bulkSearchStatus: BulkSearchStatus;

    public constructor(init?: Partial<AddBulkSearchData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AddBulkSearchResponse
{
    // @DataMember
    public data: AddBulkSearchData;

    public constructor(init?: Partial<AddBulkSearchResponse>) { (Object as any).assign(this, init); }
}

export class ArrayOfLists extends Array<string>
{

    public constructor(init?: Partial<ArrayOfLists>) { super(); (Object as any).assign(this, init); }
}

export class AddBulkSearchRequest
{
    public isSanctionsSearch: boolean;
    public isPepSearch: boolean;
    public type: string;
    public selectedLists: ArrayOfLists;

    public constructor(init?: Partial<AddBulkSearchRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AddBulkSearch extends BaseRequest
{
    // @DataMember
    public request: AddBulkSearchRequest;

    public constructor(init?: Partial<AddBulkSearch>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AddBulkSearch DTOs

POST /bulksearches/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"isSanctionsSearch":false,"isPepSearch":false,"type":"String","selectedLists":["String"]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"bulkSearchStatus":{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}