POST api/Applicant/SendLead
Send an Applicant Lead
Request Information
URI Parameters
None.
Body Parameters
ApplicantSendLeadRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| RANRequest | SendApplicantLeadRequest |
None. |
Request Formats
application/json, text/json
Sample:
{
"RANRequest": {
"Request_Type": 1,
"Property_Type": "sample string 1",
"Property_Age": "sample string 2",
"Property_Style": "sample string 3",
"Location_Type": "sample string 4",
"Parking": "sample string 5",
"Referee_Notes": "sample string 6",
"Price_Min": 7,
"Price_Max": 8,
"Referred_Suppliers": [
{
"Referred_Supplier_No": 1,
"Referred_Supplier_Name": "sample string 2"
},
{
"Referred_Supplier_No": 1,
"Referred_Supplier_Name": "sample string 2"
}
],
"Geography": [
{
"Radius": 1,
"Centre": "sample string 2"
},
{
"Radius": 1,
"Centre": "sample string 2"
}
],
"Supplier_No": 9,
"Contact_ID": 10,
"Referee_Surname": "sample string 11",
"Referee_Other_Names": "sample string 12",
"Contact_Name": "sample string 13",
"Address_1": "sample string 14",
"Address_2": "sample string 15",
"Town": "sample string 16",
"County": "sample string 17",
"Post_Outcode": "sample string 18",
"Post_Incode": "sample string 19",
"Email_Address": "sample string 20",
"Home_Phone": "sample string 21",
"Work_Phone": "sample string 22",
"Mobile_Phone_1": "sample string 23",
"Mobile_Phone_2": "sample string 24",
"Lead_Reason": "sample string 25",
"Phoned_Through_To": "sample string 26",
"Position": "sample string 27",
"Customer_Permission_Asked": "A"
}
}
application/xml, text/xml
Sample:
<ApplicantSendLeadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.Applicant">
<RANRequest>
<Address_1 xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 14</Address_1>
<Address_2 xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 15</Address_2>
<Contact_ID xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">10</Contact_ID>
<Contact_Name xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 13</Contact_Name>
<County xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 17</County>
<Customer_Permission_Asked xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">65</Customer_Permission_Asked>
<Email_Address xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 20</Email_Address>
<Home_Phone xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 21</Home_Phone>
<Lead_Reason xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 25</Lead_Reason>
<Mobile_Phone_1 xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 23</Mobile_Phone_1>
<Mobile_Phone_2 xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 24</Mobile_Phone_2>
<Phoned_Through_To xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 26</Phoned_Through_To>
<Position xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 27</Position>
<Post_Incode xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 19</Post_Incode>
<Post_Outcode xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 18</Post_Outcode>
<Referee_Other_Names xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 12</Referee_Other_Names>
<Referee_Surname xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 11</Referee_Surname>
<Supplier_No xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">9</Supplier_No>
<Town xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 16</Town>
<Work_Phone xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 22</Work_Phone>
<Geography xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
<d3p1:Geography>
<d3p1:Centre>sample string 2</d3p1:Centre>
<d3p1:Radius>1</d3p1:Radius>
</d3p1:Geography>
<d3p1:Geography>
<d3p1:Centre>sample string 2</d3p1:Centre>
<d3p1:Radius>1</d3p1:Radius>
</d3p1:Geography>
</Geography>
<Location_Type>sample string 4</Location_Type>
<Parking>sample string 5</Parking>
<Price_Max>8</Price_Max>
<Price_Min>7</Price_Min>
<Property_Age>sample string 2</Property_Age>
<Property_Style>sample string 3</Property_Style>
<Property_Type>sample string 1</Property_Type>
<Referee_Notes>sample string 6</Referee_Notes>
<Referred_Suppliers xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
<d3p1:ReferredSupplier>
<d3p1:Referred_Supplier_Name>sample string 2</d3p1:Referred_Supplier_Name>
<d3p1:Referred_Supplier_No>1</d3p1:Referred_Supplier_No>
</d3p1:ReferredSupplier>
<d3p1:ReferredSupplier>
<d3p1:Referred_Supplier_Name>sample string 2</d3p1:Referred_Supplier_Name>
<d3p1:Referred_Supplier_No>1</d3p1:Referred_Supplier_No>
</d3p1:ReferredSupplier>
</Referred_Suppliers>
<Request_Type>PropertyLettingCoverage</Request_Type>
</RANRequest>
</ApplicantSendLeadRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RANResponse
RanLeadResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| RANResponse | LeadResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"RANResponse": {
"Outcome": "A",
"Response_Type": 1,
"Response_Message": "sample string 2",
"Can_Retry": "A",
"Outcome_Type": "A",
"Supplier_No": 1,
"Lead_No": 1,
"Referred_Suppliers": [
{
"Referred_Supplier_No": 1,
"Referred_Supplier_Name": "sample string 2"
},
{
"Referred_Supplier_No": 1,
"Referred_Supplier_Name": "sample string 2"
}
],
"Email": {
"Subject": "sample string 1",
"Body": "sample string 2",
"Receiving_Supplier_Addresses": [
{
"Address": "sample string 1"
},
{
"Address": "sample string 1"
}
]
}
}
}
application/xml, text/xml
Sample:
<RanLeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
<RANResponse>
<Can_Retry>65</Can_Retry>
<Email>
<Body>sample string 2</Body>
<Receiving_Supplier_Addresses>
<EmailAddress>
<Address>sample string 1</Address>
</EmailAddress>
<EmailAddress>
<Address>sample string 1</Address>
</EmailAddress>
</Receiving_Supplier_Addresses>
<Subject>sample string 1</Subject>
</Email>
<Lead_No>1</Lead_No>
<Outcome>65</Outcome>
<Outcome_Type>65</Outcome_Type>
<Referred_Suppliers>
<ReferredSupplier>
<Referred_Supplier_Name>sample string 2</Referred_Supplier_Name>
<Referred_Supplier_No>1</Referred_Supplier_No>
</ReferredSupplier>
<ReferredSupplier>
<Referred_Supplier_Name>sample string 2</Referred_Supplier_Name>
<Referred_Supplier_No>1</Referred_Supplier_No>
</ReferredSupplier>
</Referred_Suppliers>
<Response_Message>sample string 2</Response_Message>
<Response_Type>PropertyLettingCoverage</Response_Type>
<Supplier_No>1</Supplier_No>
</RANResponse>
</RanLeadResponse>