PUT api/Applicant/AgentCoverageRequest

Request for Agent Coverage for Applicants

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
RANRequest		ApplicantCoverageRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "RANRequest": {
    "Supplier_No": 22445,
    "RequestType": 2,
    "Geography": [
      {
        "Radius": 20,
        "Centre": "Hook, Hampshire"
      },
      {
        "Radius": -1,
        "Centre": "Berkshire"
      }
    ],
    "Price_Min": 100000,
    "Price_Max": 400000,
    "Bedroom_Count": 3
  }
}

application/xml, text/xml

Sample:

<ApplicantAgentCoverageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.Applicant">
  <RANRequest>
    <Bedroom_Count>3</Bedroom_Count>
    <Geography xmlns:d3p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
      <d3p1:Geography>
        <d3p1:Centre>Hook, Hampshire</d3p1:Centre>
        <d3p1:Radius>20</d3p1:Radius>
      </d3p1:Geography>
      <d3p1:Geography>
        <d3p1:Centre>Berkshire</d3p1:Centre>
        <d3p1:Radius>-1</d3p1:Radius>
      </d3p1:Geography>
    </Geography>
    <Price_Max>400000</Price_Max>
    <Price_Min>100000</Price_Min>
    <RequestType>ApplicantReferralCoverage</RequestType>
    <Supplier_No>22445</Supplier_No>
  </RANRequest>
</ApplicantAgentCoverageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RANResponse

ApplicantAgentCoverageResponse

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",
    "Data_Protection_Msg": "sample string 3",
    "Coverage_Type": "A",
    "Outcome_Type": "A",
    "Agent_Count": 4,
    "Agent_List": [
      {
        "Property_Available": [
          {
            "Band_Start": 1,
            "Band_End": 2,
            "Property_Count": 3
          },
          {
            "Band_Start": 1,
            "Band_End": 2,
            "Property_Count": 3
          }
        ],
        "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"
      },
      {
        "Property_Available": [
          {
            "Band_Start": 1,
            "Band_End": 2,
            "Property_Count": 3
          },
          {
            "Band_Start": 1,
            "Band_End": 2,
            "Property_Count": 3
          }
        ],
        "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:

<ApplicantAgentCoverageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.Applicant">
  <RANResponse>
    <Agent_Count>4</Agent_Count>
    <Agent_List>
      <ApplicantAgent>
        <Branch_Name xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 7</Branch_Name>
        <Logo_Filename xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 4</Logo_Filename>
        <Member_Type xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 3</Member_Type>
        <Supplier_Email xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 6</Supplier_Email>
        <Supplier_Name xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 1</Supplier_Name>
        <Supplier_No xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">2</Supplier_No>
        <Supplier_Phone xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 5</Supplier_Phone>
        <Property_Available xmlns:d5p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
          <d5p1:Property>
            <d5p1:Band_End>2</d5p1:Band_End>
            <d5p1:Band_Start>1</d5p1:Band_Start>
            <d5p1:Property_Count>3</d5p1:Property_Count>
          </d5p1:Property>
          <d5p1:Property>
            <d5p1:Band_End>2</d5p1:Band_End>
            <d5p1:Band_Start>1</d5p1:Band_Start>
            <d5p1:Property_Count>3</d5p1:Property_Count>
          </d5p1:Property>
        </Property_Available>
      </ApplicantAgent>
      <ApplicantAgent>
        <Branch_Name xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 7</Branch_Name>
        <Logo_Filename xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 4</Logo_Filename>
        <Member_Type xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 3</Member_Type>
        <Supplier_Email xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 6</Supplier_Email>
        <Supplier_Name xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 1</Supplier_Name>
        <Supplier_No xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">2</Supplier_No>
        <Supplier_Phone xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">sample string 5</Supplier_Phone>
        <Property_Available xmlns:d5p1="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO">
          <d5p1:Property>
            <d5p1:Band_End>2</d5p1:Band_End>
            <d5p1:Band_Start>1</d5p1:Band_Start>
            <d5p1:Property_Count>3</d5p1:Property_Count>
          </d5p1:Property>
          <d5p1:Property>
            <d5p1:Band_End>2</d5p1:Band_End>
            <d5p1:Band_Start>1</d5p1:Band_Start>
            <d5p1:Property_Count>3</d5p1:Property_Count>
          </d5p1:Property>
        </Property_Available>
      </ApplicantAgent>
    </Agent_List>
    <Can_Retry>65</Can_Retry>
    <Coverage_Type>65</Coverage_Type>
    <Data_Protection_Msg>sample string 3</Data_Protection_Msg>
    <Outcome>65</Outcome>
    <Outcome_Type>65</Outcome_Type>
    <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>
</ApplicantAgentCoverageResponse>