PUT api/PropertyAndLetting/AgentCoverageRequest

Request for Agent Coverage for Property or Lettings

Request Information

URI Parameters

None.

Body Parameters

Request body

Name	Description	Type	Additional information
RANRequest		PropertyCoverageRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "RANRequest": {
    "Supplier_No": 22445,
    "RequestType": 1,
    "Referral_Type": "RLIS",
    "Post_Outcode": "SN5",
    "Post_Incode": "8RS"
  }
}

application/xml, text/xml

Sample:

<PropAgentCoverageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.PropertyAndLetting">
  <RANRequest>
    <Post_Incode>8RS</Post_Incode>
    <Post_Outcode>SN5</Post_Outcode>
    <Referral_Type>RLIS</Referral_Type>
    <RequestType>PropertyLettingCoverage</RequestType>
    <Supplier_No>22445</Supplier_No>
  </RANRequest>
</PropAgentCoverageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RanAgentCoverageResponse

Name	Description	Type	Additional information
RANResponse		AgentCoverageResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "RANResponse": {
    "Outcome": "A",
    "Response_Type": 1,
    "Response_Message": "sample string 2",
    "Can_Retry": "A",
    "Coverage_Type": "A",
    "Data_Protection_Msg": "sample string 3",
    "Agent_Count": 1,
    "Agent_List": [
      {
        "Supplier_Name": "sample string 1",
        "Supplier_No": 2,
        "Member_Type": "sample string 3",
        "Logo_Filename": "sample string 4",
        "Supplier_Phone": "sample string 5",
        "Supplier_Email": "sample string 6",
        "Branch_Name": "sample string 7"
      },
      {
        "Supplier_Name": "sample string 1",
        "Supplier_No": 2,
        "Member_Type": "sample string 3",
        "Logo_Filename": "sample string 4",
        "Supplier_Phone": "sample string 5",
        "Supplier_Email": "sample string 6",
        "Branch_Name": "sample string 7"
      }
    ],
    "Staff_Members": [
      {
        "Contact_ID": 1,
        "Person_Name": "sample string 2",
        "Job_Title": "sample string 3",
        "Email": "sample string 4"
      },
      {
        "Contact_ID": 1,
        "Person_Name": "sample string 2",
        "Job_Title": "sample string 3",
        "Email": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<RanAgentCoverageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.PropertyAndLetting">
  <RANResponse>
    <Agent_Count>1</Agent_Count>
    <Agent_List xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
      <d3p1:Agent>
        <d3p1:Branch_Name>sample string 7</d3p1:Branch_Name>
        <d3p1:Logo_Filename>sample string 4</d3p1:Logo_Filename>
        <d3p1:Member_Type>sample string 3</d3p1:Member_Type>
        <d3p1:Supplier_Email>sample string 6</d3p1:Supplier_Email>
        <d3p1:Supplier_Name>sample string 1</d3p1:Supplier_Name>
        <d3p1:Supplier_No>2</d3p1:Supplier_No>
        <d3p1:Supplier_Phone>sample string 5</d3p1:Supplier_Phone>
      </d3p1:Agent>
      <d3p1:Agent>
        <d3p1:Branch_Name>sample string 7</d3p1:Branch_Name>
        <d3p1:Logo_Filename>sample string 4</d3p1:Logo_Filename>
        <d3p1:Member_Type>sample string 3</d3p1:Member_Type>
        <d3p1:Supplier_Email>sample string 6</d3p1:Supplier_Email>
        <d3p1:Supplier_Name>sample string 1</d3p1:Supplier_Name>
        <d3p1:Supplier_No>2</d3p1:Supplier_No>
        <d3p1:Supplier_Phone>sample string 5</d3p1:Supplier_Phone>
      </d3p1:Agent>
    </Agent_List>
    <Can_Retry>65</Can_Retry>
    <Coverage_Type>65</Coverage_Type>
    <Data_Protection_Msg>sample string 3</Data_Protection_Msg>
    <Outcome>65</Outcome>
    <Response_Message>sample string 2</Response_Message>
    <Response_Type>PropertyLettingCoverage</Response_Type>
    <Staff_Members xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
      <d3p1:StaffMember>
        <d3p1:Contact_ID>1</d3p1:Contact_ID>
        <d3p1:Email>sample string 4</d3p1:Email>
        <d3p1:Job_Title>sample string 3</d3p1:Job_Title>
        <d3p1:Person_Name>sample string 2</d3p1:Person_Name>
      </d3p1:StaffMember>
      <d3p1:StaffMember>
        <d3p1:Contact_ID>1</d3p1:Contact_ID>
        <d3p1:Email>sample string 4</d3p1:Email>
        <d3p1:Job_Title>sample string 3</d3p1:Job_Title>
        <d3p1:Person_Name>sample string 2</d3p1:Person_Name>
      </d3p1:StaffMember>
    </Staff_Members>
  </RANResponse>
</RanAgentCoverageResponse>