| GET | /dbs | Get all DBS Searches |
|---|
// @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 PagedRequest extends BaseRequest
{
/** @description The maximum number of records to be returned in one page */
// @DataMember(Name="page[limit]")
// @ApiMember(Description="The maximum number of records to be returned in one page", ParameterType="query")
public page_limit_: number;
/** @description The starting point in the list of records from where the data should be fetched. Zero based index. */
// @DataMember(Name="page[offset]")
// @ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.", ParameterType="query")
public page_offset_: number;
/** @description The term to determine the order in which the data is returned */
// @DataMember
// @ApiMember(Description="The term to determine the order in which the data is returned", ParameterType="query")
public sort: string;
public constructor(init?: Partial<PagedRequest>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class GetDbsSearches extends PagedRequest
{
/** @description Filter the results to those that have a Name including the specified value */
// @DataMember
// @ApiMember(Description="Filter the results to those that have a Name including the specified value", ParameterType="query")
public name: string;
/** @description Filter the results to those that were created after (or on) this date */
// @DataMember
// @ApiMember(Description="Filter the results to those that were created after (or on) this date", ParameterType="query")
public dateFrom?: string;
/** @description Filter the results to those that were created before this date */
// @DataMember
// @ApiMember(Description="Filter the results to those that were created before this date", ParameterType="query")
public dateTo?: string;
/** @description Filter the results to those where the applicant has provided their information (true), or not (false), or either (null) */
// @DataMember
// @ApiMember(Description="Filter the results to those where the applicant has provided their information (true), or not (false), or either (null)", ParameterType="query")
public isApplicantInfoCompleted?: boolean;
/** @description Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null) */
// @DataMember
// @ApiMember(Description="Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null)", ParameterType="query")
public isIdCheckCompleted?: boolean;
/** @description Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null) */
// @DataMember
// @ApiMember(Description="Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null)", ParameterType="query")
public isApplicationCompleted?: boolean;
/** @description Filter the results to those where the application has been submitted (true), or not (false), or either (null) */
// @DataMember
// @ApiMember(Description="Filter the results to those where the application has been submitted (true), or not (false), or either (null)", ParameterType="query")
public isApplicationSubmitted?: boolean;
/** @description Filter the results to those where the application has been disclosed (true), or not (false), or either (null) */
// @DataMember
// @ApiMember(Description="Filter the results to those where the application has been disclosed (true), or not (false), or either (null)", ParameterType="query")
public isApplicationDisclosed?: boolean;
/** @description If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view */
// @DataMember
// @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", ParameterType="query")
public subUserName: string;
public constructor(init?: Partial<GetDbsSearches>) { super(init); (Object as any).assign(this, init); }
}
export class DbsSearchShort
{
public id: number;
public dateSearched: string;
public dateUpdated: string;
public status: string;
public disclosureStatus: string;
public isApplicantInfoCompleted: boolean;
public isIdCheckCompleted: boolean;
public isApplicationCompleted: boolean;
public isApplicationSubmitted: boolean;
public isApplicationDisclosed: boolean;
public disclosureLevel: string;
public name: string;
public reference: string;
public constructor(init?: Partial<DbsSearchShort>) { (Object as any).assign(this, init); }
}
export class ArrayOfDbsSearchShort extends Array<DbsSearchShort>
{
public constructor(init?: Partial<ArrayOfDbsSearchShort>) { super(); (Object as any).assign(this, init); }
}
export class GetDbsSearchesData extends PagedResponse<GetDbsSearches>
{
public searches: ArrayOfDbsSearchShort;
public constructor(init?: Partial<GetDbsSearchesData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class GetDbsSearchesResponse
{
// @DataMember
public data: GetDbsSearchesData;
public constructor(init?: Partial<GetDbsSearchesResponse>) { (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 PagedResponse<T> extends BaseResponse
{
/** @description The response Metadata */
// @ApiMember(Description="The response Metadata")
public meta: Meta<T>;
public constructor(init?: Partial<PagedResponse<T>>) { super(init); (Object as any).assign(this, init); }
}
export class Links
{
// @ApiMember()
public self: string;
public constructor(init?: Partial<Links>) { (Object as any).assign(this, init); }
}
export class MetaLinks extends Links
{
/** @description The link to the first page of records */
// @ApiMember(Description="The link to the first page of records")
public first: string;
/** @description The link to the last page of records */
// @ApiMember(Description="The link to the last page of records")
public last: string;
/** @description The link to the next page of records, if applicable */
// @ApiMember(Description="The link to the next page of records, if applicable")
public next: string;
/** @description The link to the last page of records, if applicable */
// @ApiMember(Description="The link to the last page of records, if applicable")
public prev: string;
public constructor(init?: Partial<MetaLinks>) { super(init); (Object as any).assign(this, init); }
}
export class Meta<T>
{
/** @description Pagination links */
// @ApiMember(Description="Pagination links")
public links: MetaLinks;
/** @description The total number of records for the query */
// @ApiMember(Description="The total number of records for the query")
public totalCount?: number;
/** @description The maximum number of records to be returned in one page */
// @ApiMember(Description="The maximum number of records to be returned in one page")
public pageLimit?: number;
/** @description The starting point in the list of records from where the data should be fetched. Zero based index. */
// @ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.")
public pageOffset?: number;
public constructor(init?: Partial<Meta<T>>) { (Object as any).assign(this, init); }
}
TypeScript GetDbsSearches 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.
GET /dbs HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"searches":[{"id":0,"dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","status":"String","disclosureStatus":"String","isApplicantInfoCompleted":false,"isIdCheckCompleted":false,"isApplicationCompleted":false,"isApplicationSubmitted":false,"isApplicationDisclosed":false,"disclosureLevel":"String","name":"String","reference":"String"}],"meta":{"links":{"first":"String","last":"String","next":"String","prev":"String","self":"String"},"totalCount":0,"pageLimit":0,"pageOffset":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}