POST ApplicantEnquiry
Request Information
URI Parameters
None.
Body Parameters
ApplicantEnquiryRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Demographics | ApplicantDemographics |
None. |
|
| Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Demographics": {
"Identifier": "sample string 1",
"FirstName": "sample string 2",
"Surname": "sample string 3",
"MobileNumber": "sample string 4",
"Email": "sample string 5"
},
"Token": "sample string 1"
}
application/xml, text/xml
Sample:
<ApplicantEnquiryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AfiswitchCIOD.Models">
<Token>sample string 1</Token>
<Demographics>
<Email>sample string 5</Email>
<FirstName>sample string 2</FirstName>
<Identifier>sample string 1</Identifier>
<MobileNumber>sample string 4</MobileNumber>
<Surname>sample string 3</Surname>
</Demographics>
</ApplicantEnquiryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApplicantEnquiryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicantID | integer |
None. |
|
| CIODIdentifiers | Collection of string |
None. |
|
| SearchTypes | Collection of SearchTypeData |
None. |
|
| Genders | Collection of LookupItem |
None. |
|
| EthnicGroups | Collection of LookupItem |
None. |
|
| Response | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"ApplicantID": 1,
"CIODIdentifiers": [
"sample string 1",
"sample string 2"
],
"SearchTypes": [
{
"Type": 1,
"Description": "sample string 2",
"SearchServiceTypes": [
{
"ServiceType": 0,
"Description": "Standard",
"TurnaroundHours": 1,
"Price": 2.1
},
{
"ServiceType": 0,
"Description": "Standard",
"TurnaroundHours": 1,
"Price": 2.1
}
]
},
{
"Type": 1,
"Description": "sample string 2",
"SearchServiceTypes": [
{
"ServiceType": 0,
"Description": "Standard",
"TurnaroundHours": 1,
"Price": 2.1
},
{
"ServiceType": 0,
"Description": "Standard",
"TurnaroundHours": 1,
"Price": 2.1
}
]
}
],
"Genders": [
{
"Id": 1,
"Description": "sample string 2"
},
{
"Id": 1,
"Description": "sample string 2"
}
],
"EthnicGroups": [
{
"Id": 1,
"Description": "sample string 2"
},
{
"Id": 1,
"Description": "sample string 2"
}
],
"Response": {
"ResponseCode": 1,
"ResponseMessage": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ApplicantEnquiryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AfiswitchCIOD.Models">
<Response>
<ResponseCode>1</ResponseCode>
<ResponseMessage>sample string 2</ResponseMessage>
</Response>
<ApplicantID>1</ApplicantID>
<CIODIdentifiers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</CIODIdentifiers>
<EthnicGroups>
<LookupItem>
<Description>sample string 2</Description>
<Id>1</Id>
</LookupItem>
<LookupItem>
<Description>sample string 2</Description>
<Id>1</Id>
</LookupItem>
</EthnicGroups>
<Genders>
<LookupItem>
<Description>sample string 2</Description>
<Id>1</Id>
</LookupItem>
<LookupItem>
<Description>sample string 2</Description>
<Id>1</Id>
</LookupItem>
</Genders>
<SearchTypes>
<SearchTypeData>
<Description>sample string 2</Description>
<SearchServiceTypes>
<SearchServiceType>
<Price>2.1</Price>
<ServiceType>Standard</ServiceType>
<TurnaroundHours>1</TurnaroundHours>
</SearchServiceType>
<SearchServiceType>
<Price>2.1</Price>
<ServiceType>Standard</ServiceType>
<TurnaroundHours>1</TurnaroundHours>
</SearchServiceType>
</SearchServiceTypes>
<Type>1</Type>
</SearchTypeData>
<SearchTypeData>
<Description>sample string 2</Description>
<SearchServiceTypes>
<SearchServiceType>
<Price>2.1</Price>
<ServiceType>Standard</ServiceType>
<TurnaroundHours>1</TurnaroundHours>
</SearchServiceType>
<SearchServiceType>
<Price>2.1</Price>
<ServiceType>Standard</ServiceType>
<TurnaroundHours>1</TurnaroundHours>
</SearchServiceType>
</SearchServiceTypes>
<Type>1</Type>
</SearchTypeData>
</SearchTypes>
</ApplicantEnquiryResponse>