POST api/PropertyAndLetting/SendReferral

Send a Property or Letting Lead

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
RANRequest		SendPropReferralRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "RANRequest": {
    "Referral_Type": "sample string 1",
    "Referral_Sub_Type": 1,
    "Request_Type": 1,
    "Plot_Names": [
      {
        "Plot_Name": "sample string 1"
      },
      {
        "Plot_Name": "sample string 1"
      }
    ],
    "Referral_Notes": "sample string 2",
    "On_Market_Price": 3,
    "On_Market_With_1": "sample string 4",
    "On_Market_With_2": "sample string 5",
    "On_Market_With_3": "sample string 6",
    "Notification_URL": "sample string 7",
    "NotificationParameters": [
      {
        "ParamName": "sample string 1",
        "ParamValue": "sample string 2"
      },
      {
        "ParamName": "sample string 1",
        "ParamValue": "sample string 2"
      }
    ],
    "Referred_Suppliers": [
      {
        "Referred_Supplier_No": 1,
        "Referred_Supplier_Name": "sample string 2"
      },
      {
        "Referred_Supplier_No": 1,
        "Referred_Supplier_Name": "sample string 2"
      }
    ],
    "Supplier_No": 8,
    "Contact_ID": 9,
    "Referred_By": 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",
    "Referral_Reason": "sample string 25",
    "Phoned_Through_To": "sample string 26",
    "Position": "sample string 27",
    "Customer_Permission_Asked": "A"
  }
}

application/xml, text/xml

Sample:

<PropSendReferralRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.PropertyAndLetting">
  <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">9</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>
    <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>
    <Referral_Reason xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 25</Referral_Reason>
    <Referred_By xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">10</Referred_By>
    <Supplier_No xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">8</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>
    <NotificationParameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
      <d3p1:NotificationParameters>
        <d3p1:ParamName>sample string 1</d3p1:ParamName>
        <d3p1:ParamValue>sample string 2</d3p1:ParamValue>
      </d3p1:NotificationParameters>
      <d3p1:NotificationParameters>
        <d3p1:ParamName>sample string 1</d3p1:ParamName>
        <d3p1:ParamValue>sample string 2</d3p1:ParamValue>
      </d3p1:NotificationParameters>
    </NotificationParameters>
    <Notification_URL>sample string 7</Notification_URL>
    <On_Market_Price>3</On_Market_Price>
    <On_Market_With_1>sample string 4</On_Market_With_1>
    <On_Market_With_2>sample string 5</On_Market_With_2>
    <On_Market_With_3>sample string 6</On_Market_With_3>
    <Plot_Names xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
      <d3p1:Plot>
        <d3p1:Plot_Name>sample string 1</d3p1:Plot_Name>
      </d3p1:Plot>
      <d3p1:Plot>
        <d3p1:Plot_Name>sample string 1</d3p1:Plot_Name>
      </d3p1:Plot>
    </Plot_Names>
    <Referral_Notes>sample string 2</Referral_Notes>
    <Referral_Sub_Type>SingleProperty</Referral_Sub_Type>
    <Referral_Type>sample string 1</Referral_Type>
    <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>
</PropSendReferralRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RANResponse

RanReferralResponse

Name	Description	Type	Additional information
RANResponse		ReferralResponse	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,
    "Referral_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:

<RanReferralResponse 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>
    <Outcome>65</Outcome>
    <Outcome_Type>65</Outcome_Type>
    <Referral_No>1</Referral_No>
    <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>
</RanReferralResponse>