| POST | /dbs | Add a DBS Search |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.DbsSearches
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types
Namespace Global
Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
Public Partial Class ArrayOfResponseError
Inherits List(Of ResponseError)
End Class
<DataContract>
Public Partial Class BaseRequest
Implements IBaseRequest
'''<Summary>
'''The authentication credentials
'''</Summary>
<DataMember>
<ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property Authentication As Authentication
End Class
Public Partial Class BaseResponse
Implements IBaseDataResponse
Implements IHasResponseStatus
'''<Summary>
'''The status of the response
'''</Summary>
<ApiMember(Description:="The status of the response")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<DataContract>
Public Partial Class ResponseError
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property FieldName As String
<DataMember(Order:=3)>
Public Overridable Property Message As String
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
<DataContract>
Public Partial Class ResponseStatus
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property Message As String
<DataMember(Order:=3)>
Public Overridable Property StackTrace As String
<DataMember(Order:=4)>
Public Overridable Property Errors As ArrayOfResponseError
<DataMember(Order:=5)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Operations.DbsSearches
<DataContract>
Public Partial Class AddDbsSearch
Inherits BaseRequest
<DataMember>
Public Overridable Property Request As AddDbsSearchRequest
End Class
Public Partial Class AddDbsSearchData
Inherits BaseResponse
Implements IBaseSearchResponse
Public Overridable Property LinkedTo As ArrayOfLinkedTo
Public Overridable Property Summary As DbsSearchSummary
End Class
Public Partial Class AddDbsSearchRequest
'''<Summary>
'''The full name of the applicant
'''</Summary>
<ApiMember(Description:="The full name of the applicant", IsRequired:=true)>
Public Overridable Property Name As String
'''<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 Overridable Property DateOfBirth As String
'''<Summary>
'''The email address of the applicant
'''</Summary>
<ApiMember(Description:="The email address of the applicant", IsRequired:=true)>
Public Overridable Property Email As String
'''<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 Overridable Property MobileInternational As String
'''<Summary>
'''The country where the job is located
'''</Summary>
<ApiMember(Description:="The country where the job is located", IsRequired:=true)>
Public Overridable Property JobLocation As String
'''<Summary>
'''The disclosure level of the DBS required
'''</Summary>
<ApiMember(Description:="The disclosure level of the DBS required", IsRequired:=true)>
Public Overridable Property DisclosureLevel As String
'''<Summary>
'''Your reference, if any
'''</Summary>
<ApiMember(Description:="Your reference, if any")>
Public Overridable Property Reference As String
'''<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 Overridable Property SubUserName As String
'''<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 Overridable Property LinkedTo As ArrayOfLinkedTo
End Class
<DataContract>
Public Partial Class AddDbsSearchResponse
<DataMember>
Public Overridable Property Data As AddDbsSearchData
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Types
Public Partial Class ApplicantInformation
Public Overridable Property Name As String
Public Overridable Property DateOfBirth As String
Public Overridable Property Email As String
Public Overridable Property MobileInternational As String
Public Overridable Property JobLocation As String
Public Overridable Property Reference As String
End Class
Public Partial Class ArrayOfLinkedTo
Inherits List(Of LinkedTo)
End Class
<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 Overridable Property ApiUserId As String
'''<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 Overridable Property ApiUserKey As String
End Class
Public Partial Class DbsSearchSummary
Public Overridable Property Id As Long
Public Overridable Property DateSearched As Date
Public Overridable Property DateUpdated As Date
Public Overridable Property Status As String
Public Overridable Property DisclosureStatus As String
Public Overridable Property IsApplicantInfoCompleted As Boolean
Public Overridable Property IsIdCheckCompleted As Boolean
Public Overridable Property IsApplicationCompleted As Boolean
Public Overridable Property IsApplicationSubmitted As Boolean
Public Overridable Property IsApplicationDisclosed As Boolean
Public Overridable Property DisclosureLevel As String
Public Overridable Property ApplicantInformation As ApplicantInformation
End Class
Public Partial Class LinkedTo
Public Overridable Property ClientId As Nullable(Of Integer)
Public Overridable Property Id As Nullable(Of Long)
Public Overridable Property Type As String
Public Overridable Property Subtype As String
Public Overridable Property Status As String
Public Overridable Property Description As String
Public Overridable Property IsArchived As Nullable(Of Boolean)
Public Overridable Property Name As String
Public Overridable Property [Date] As Nullable(Of Date)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<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>