| Add a DBS Search |
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract
open class AddDbsSearch : BaseRequest()
{
@DataMember
var request:AddDbsSearchRequest? = null
}
@DataContract
open class BaseRequest : IBaseRequest
{
/**
* The authentication credentials
*/
@DataMember
@ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
var authentication:Authentication? = null
}
@DataContract
open class Authentication
{
/**
* 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")
var apiUserId:String? = null
/**
* 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")
var apiUserKey:String? = null
}
open class AddDbsSearchRequest
{
/**
* The full name of the applicant
*/
@ApiMember(Description="The full name of the applicant", IsRequired=true)
var name:String? = null
/**
* 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)
var dateOfBirth:String? = null
/**
* The email address of the applicant
*/
@ApiMember(Description="The email address of the applicant", IsRequired=true)
var email:String? = null
/**
* 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)
var mobileInternational:String? = null
/**
* The country where the job is located
*/
@ApiMember(Description="The country where the job is located", IsRequired=true)
var jobLocation:String? = null
/**
* The disclosure level of the DBS required
*/
@ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)
var disclosureLevel:String? = null
/**
* Your reference, if any
*/
@ApiMember(Description="Your reference, if any")
var reference:String? = null
/**
* 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")
var subUserName:String? = null
/**
* 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")
var linkedTo:ArrayOfLinkedTo? = null
}
open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}
open class LinkedTo
{
var clientId:Int? = null
var id:Long? = null
@SerializedName("type") var Type:String? = null
var subtype:String? = null
var status:String? = null
var description:String? = null
var isArchived:Boolean? = null
var name:String? = null
var date:Date? = null
}
@DataContract
open class AddDbsSearchResponse
{
@DataMember
@SerializedName("data") var Data:AddDbsSearchData? = null
}
open class AddDbsSearchData : BaseResponse(), IBaseSearchResponse
{
var linkedTo:ArrayOfLinkedTo? = null
var summary:DbsSearchSummary? = null
}
open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
/**
* The status of the response
*/
@ApiMember(Description="The status of the response")
var responseStatus:ResponseStatus? = null
}
open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}
open class DbsSearchSummary
{
var id:Long? = null
var dateSearched:Date? = null
var dateUpdated:Date? = null
var status:String? = null
var disclosureStatus:String? = null
var isApplicantInfoCompleted:Boolean? = null
var isIdCheckCompleted:Boolean? = null
var isApplicationCompleted:Boolean? = null
var isApplicationSubmitted:Boolean? = null
var isApplicationDisclosed:Boolean? = null
var disclosureLevel:String? = null
var applicantInformation:ApplicantInformation? = null
}
open class ApplicantInformation
{
var name:String? = null
var dateOfBirth:String? = null
var email:String? = null
var mobileInternational:String? = null
var jobLocation:String? = null
var reference:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddDbsSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<DateOfBirth>String</DateOfBirth>
<DisclosureLevel>String</DisclosureLevel>
<Email>String</Email>
<JobLocation>String</JobLocation>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<MobileInternational>String</MobileInternational>
<Name>String</Name>
<Reference>String</Reference>
<SubUserName>String</SubUserName>
</Request>
</AddDbsSearch>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddDbsSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<Summary>
<ApplicantInformation>
<DateOfBirth>String</DateOfBirth>
<Email>String</Email>
<JobLocation>String</JobLocation>
<MobileInternational>String</MobileInternational>
<Name>String</Name>
<Reference>String</Reference>
</ApplicantInformation>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<DisclosureLevel>String</DisclosureLevel>
<DisclosureStatus>String</DisclosureStatus>
<Id>0</Id>
<IsApplicantInfoCompleted>false</IsApplicantInfoCompleted>
<IsApplicationCompleted>false</IsApplicationCompleted>
<IsApplicationDisclosed>false</IsApplicationDisclosed>
<IsApplicationSubmitted>false</IsApplicationSubmitted>
<IsIdCheckCompleted>false</IsIdCheckCompleted>
<Status>String</Status>
</Summary>
</Data>
</AddDbsSearchResponse>
</soap12:Body>
</soap12:Envelope>