Sanctions Search API: v2

<back to all web services

GetBulkSearchHistory

// @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 ArrayOfBulkSearchStatus extends Array<BulkSearchStatus>
{

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

export class GetBulkSearchHistoryData extends BaseResponse
{
    public bulkSearchList: ArrayOfBulkSearchStatus;
    public currentPageNum: number;
    public maxPageNum: number;
    public totalBulkSearches: number;
    public pageSize: number;

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

// @DataContract
export class GetBulkSearchHistoryResponse
{
    // @DataMember
    public data: GetBulkSearchHistoryData;

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

export class GetBulkSearchHistoryRequest
{
    public subUserName: string;
    public page: number;
    public sortOrder: string;
    /** @description The user id to filter on, in string format (GUID) */
    // @ApiMember(Description="The user id to filter on, in string format (GUID)")
    public whereUserId: string;

    public whereDateFrom?: string;
    public whereDateTo?: string;
    public whereId?: number;
    public pageSize: number;

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

// @DataContract
export class GetBulkSearchHistory extends BaseRequest
{
    // @DataMember
    public request: GetBulkSearchHistoryRequest;

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

TypeScript GetBulkSearchHistory DTOs

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"}}}}