| POST | /dbs | Add a DBS Search |
|---|
// @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 LinkedTo
{
public clientId?: number;
public id?: number;
public type?: string;
public subtype?: string;
public status?: string;
public description?: string;
public isArchived?: boolean;
public name?: string;
public date?: string;
public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}
export class ArrayOfLinkedTo extends Array<LinkedTo>
{
public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}
export class ApplicantInformation
{
public name: string;
public dateOfBirth: string;
public email: string;
public mobileInternational: string;
public jobLocation: string;
public reference: string;
public constructor(init?: Partial<ApplicantInformation>) { (Object as any).assign(this, init); }
}
export class DbsSearchSummary
{
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 applicantInformation: ApplicantInformation;
public constructor(init?: Partial<DbsSearchSummary>) { (Object as any).assign(this, init); }
}
export class AddDbsSearchData extends BaseResponse implements IBaseSearchResponse
{
public linkedTo: ArrayOfLinkedTo;
public summary: DbsSearchSummary;
public constructor(init?: Partial<AddDbsSearchData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class AddDbsSearchResponse
{
// @DataMember
public data: AddDbsSearchData;
public constructor(init?: Partial<AddDbsSearchResponse>) { (Object as any).assign(this, init); }
}
export class AddDbsSearchRequest
{
/** @description The full name of the applicant */
// @ApiMember(Description="The full name of the applicant", IsRequired=true)
public name: string;
/** @description 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)
public dateOfBirth: string;
/** @description The email address of the applicant */
// @ApiMember(Description="The email address of the applicant", IsRequired=true)
public email: string;
/** @description 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)
public mobileInternational: string;
/** @description The country where the job is located */
// @ApiMember(Description="The country where the job is located", IsRequired=true)
public jobLocation: string;
/** @description The disclosure level of the DBS required */
// @ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)
public disclosureLevel: string;
/** @description Your reference, if any */
// @ApiMember(Description="Your reference, if any")
public reference: string;
/** @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 */
// @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")
public subUserName: string;
/** @description 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")
public linkedTo: ArrayOfLinkedTo;
public constructor(init?: Partial<AddDbsSearchRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class AddDbsSearch extends BaseRequest
{
// @DataMember
public request: AddDbsSearchRequest;
public constructor(init?: Partial<AddDbsSearch>) { super(init); (Object as any).assign(this, init); }
}
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 /dbs HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"name":"String","dateOfBirth":"String","email":"String","mobileInternational":"String","jobLocation":"String","disclosureLevel":"String","reference":"String","subUserName":"String","linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"summary":{"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","applicantInformation":{"name":"String","dateOfBirth":"String","email":"String","mobileInternational":"String","jobLocation":"String","reference":"String"}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}