| POST | /dbs | Add a DBS Search |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.DbsSearches;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
public partial class ArrayOfResponseError
: List<ResponseError>
{
}
[DataContract]
public partial class BaseRequest
: IBaseRequest
{
///<summary>
///The authentication credentials
///</summary>
[DataMember]
[ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
public virtual Authentication Authentication { get; set; }
}
public partial class BaseResponse
: IBaseDataResponse, IHasResponseStatus
{
///<summary>
///The status of the response
///</summary>
[ApiMember(Description="The status of the response")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
[DataContract]
public partial class ResponseError
{
public ResponseError()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual string ErrorCode { get; set; }
[DataMember(Order=2)]
public virtual string FieldName { get; set; }
[DataMember(Order=3)]
public virtual string Message { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
}
[DataContract]
public partial class ResponseStatus
{
public ResponseStatus()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual string ErrorCode { get; set; }
[DataMember(Order=2)]
public virtual string Message { get; set; }
[DataMember(Order=3)]
public virtual string StackTrace { get; set; }
[DataMember(Order=4)]
public virtual ArrayOfResponseError Errors { get; set; }
[DataMember(Order=5)]
public virtual Dictionary<string, string> Meta { get; set; }
}
}
namespace SanctionsSearch.Api2.ServiceModel.Operations.DbsSearches
{
[DataContract]
public partial class AddDbsSearch
: BaseRequest
{
[DataMember]
public virtual AddDbsSearchRequest Request { get; set; }
}
public partial class AddDbsSearchData
: BaseResponse, IBaseSearchResponse
{
public virtual ArrayOfLinkedTo LinkedTo { get; set; }
public virtual DbsSearchSummary Summary { get; set; }
}
public partial class AddDbsSearchRequest
{
///<summary>
///The full name of the applicant
///</summary>
[ApiMember(Description="The full name of the applicant", IsRequired=true)]
public virtual string Name { get; set; }
///<summary>
///The date of birth for the applicant (DD/MM/YYYY format)
///</summary>
[ApiMember(Description="The date of birth for the applicant (DD/MM/YYYY format)", IsRequired=true)]
public virtual string DateOfBirth { get; set; }
///<summary>
///The email address of the applicant
///</summary>
[ApiMember(Description="The email address of the applicant", IsRequired=true)]
public virtual string Email { get; set; }
///<summary>
///The applicant's mobile phone number in international format (e.g. '+447123456789')
///</summary>
[ApiMember(Description="The applicant's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)]
public virtual string MobileInternational { get; set; }
///<summary>
///The country where the job is located
///</summary>
[ApiMember(Description="The country where the job is located", IsRequired=true)]
public virtual string JobLocation { get; set; }
///<summary>
///The disclosure level of the DBS required
///</summary>
[ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)]
public virtual string DisclosureLevel { get; set; }
///<summary>
///Your reference, if any
///</summary>
[ApiMember(Description="Your reference, if any")]
public virtual string Reference { get; set; }
///<summary>
///If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account
///</summary>
[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 virtual string SubUserName { get; set; }
///<summary>
///If the search should be linked to other searches, specify the them here
///</summary>
[ApiMember(Description="If the search should be linked to other searches, specify the them here")]
public virtual ArrayOfLinkedTo LinkedTo { get; set; }
}
[DataContract]
public partial class AddDbsSearchResponse
{
[DataMember]
public virtual AddDbsSearchData Data { get; set; }
}
}
namespace SanctionsSearch.Api2.ServiceModel.Types
{
public partial class ApplicantInformation
{
public virtual string Name { get; set; }
public virtual string DateOfBirth { get; set; }
public virtual string Email { get; set; }
public virtual string MobileInternational { get; set; }
public virtual string JobLocation { get; set; }
public virtual string Reference { get; set; }
}
public partial class ArrayOfLinkedTo
: List<LinkedTo>
{
}
[DataContract]
public partial class Authentication
{
///<summary>
///The API User ID provided by us when you signed up to use our API
///</summary>
[DataMember]
[ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
public virtual string ApiUserId { get; set; }
///<summary>
///The API User Key provided by us when you signed up to use our API
///</summary>
[DataMember]
[ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
public virtual string ApiUserKey { get; set; }
}
public partial class DbsSearchSummary
{
public virtual long Id { get; set; }
public virtual DateTime DateSearched { get; set; }
public virtual DateTime DateUpdated { get; set; }
public virtual string Status { get; set; }
public virtual string DisclosureStatus { get; set; }
public virtual bool IsApplicantInfoCompleted { get; set; }
public virtual bool IsIdCheckCompleted { get; set; }
public virtual bool IsApplicationCompleted { get; set; }
public virtual bool IsApplicationSubmitted { get; set; }
public virtual bool IsApplicationDisclosed { get; set; }
public virtual string DisclosureLevel { get; set; }
public virtual ApplicantInformation ApplicantInformation { get; set; }
}
public partial class LinkedTo
{
public virtual int? ClientId { get; set; }
public virtual long? Id { get; set; }
public virtual string Type { get; set; }
public virtual string Subtype { get; set; }
public virtual string Status { get; set; }
public virtual string Description { get; set; }
public virtual bool? IsArchived { get; set; }
public virtual string Name { get; set; }
public virtual DateTime? Date { get; set; }
}
}
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"}}}}