POST v1/prospect

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
key	string	None.
accountName	string	None.
prospectDetails	ProspectInformation	None.

Request Formats

application/json, text/json

Sample:

{
  "key": "sample string 1",
  "accountName": "sample string 2",
  "prospectDetails": {
    "ireProspectID": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "email": "sample string 4",
    "mobile": "sample string 5",
    "company": "sample string 6",
    "jobTitle": "sample string 7",
    "comments": "sample string 8",
    "moveInDate": "sample string 9",
    "petsAllowed": 1,
    "minBeds": 10,
    "maxBeds": 11,
    "minBaths": 12,
    "maxBaths": 13,
    "minPrice": 14.1,
    "maxPrice": 15.1,
    "garages": 16,
    "suburbs": "sample string 17",
    "type": 0,
    "prospectsource": "sample string 18"
  }
}

application/xml, text/xml

Sample:

<ProspectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models">
  <accountName>sample string 2</accountName>
  <key>sample string 1</key>
  <prospectDetails>
    <comments>sample string 8</comments>
    <company>sample string 6</company>
    <email>sample string 4</email>
    <firstName>sample string 2</firstName>
    <garages>16</garages>
    <ireProspectID>1</ireProspectID>
    <jobTitle>sample string 7</jobTitle>
    <lastName>sample string 3</lastName>
    <maxBaths>13</maxBaths>
    <maxBeds>11</maxBeds>
    <maxPrice>15.1</maxPrice>
    <minBaths>12</minBaths>
    <minBeds>10</minBeds>
    <minPrice>14.1</minPrice>
    <mobile>sample string 5</mobile>
    <moveInDate>sample string 9</moveInDate>
    <petsAllowed>1</petsAllowed>
    <prospectsource>sample string 18</prospectsource>
    <suburbs>sample string 17</suburbs>
    <type>Rental</type>
  </prospectDetails>
</ProspectRequest>

multipart/form-data

Sample:

<ProspectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><accountName>sample string 2</accountName><key>sample string 1</key><prospectDetails><comments>sample string 8</comments><company>sample string 6</company><email>sample string 4</email><firstName>sample string 2</firstName><garages>16</garages><ireProspectID>1</ireProspectID><jobTitle>sample string 7</jobTitle><lastName>sample string 3</lastName><maxBaths>13</maxBaths><maxBeds>11</maxBeds><maxPrice>15.1</maxPrice><minBaths>12</minBaths><minBeds>10</minBeds><minPrice>14.1</minPrice><mobile>sample string 5</mobile><moveInDate>sample string 9</moveInDate><petsAllowed>1</petsAllowed><prospectsource>sample string 18</prospectsource><suburbs>sample string 17</suburbs><type>Rental</type></prospectDetails></ProspectRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProspectResponse

Name	Type	Additional information
status	ProspectResponseStatus	None.
statusReason	string	None.
prospectDetails	ProspectInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "statusReason": "sample string 1",
  "prospectDetails": {
    "ireProspectID": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "email": "sample string 4",
    "mobile": "sample string 5",
    "company": "sample string 6",
    "jobTitle": "sample string 7",
    "comments": "sample string 8",
    "moveInDate": "sample string 9",
    "petsAllowed": 1,
    "minBeds": 10,
    "maxBeds": 11,
    "minBaths": 12,
    "maxBaths": 13,
    "minPrice": 14.1,
    "maxPrice": 15.1,
    "garages": 16,
    "suburbs": "sample string 17",
    "type": 0,
    "prospectsource": "sample string 18"
  }
}

application/xml, text/xml

Sample:

<ProspectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models">
  <prospectDetails>
    <comments>sample string 8</comments>
    <company>sample string 6</company>
    <email>sample string 4</email>
    <firstName>sample string 2</firstName>
    <garages>16</garages>
    <ireProspectID>1</ireProspectID>
    <jobTitle>sample string 7</jobTitle>
    <lastName>sample string 3</lastName>
    <maxBaths>13</maxBaths>
    <maxBeds>11</maxBeds>
    <maxPrice>15.1</maxPrice>
    <minBaths>12</minBaths>
    <minBeds>10</minBeds>
    <minPrice>14.1</minPrice>
    <mobile>sample string 5</mobile>
    <moveInDate>sample string 9</moveInDate>
    <petsAllowed>1</petsAllowed>
    <prospectsource>sample string 18</prospectsource>
    <suburbs>sample string 17</suburbs>
    <type>Rental</type>
  </prospectDetails>
  <status>Ok</status>
  <statusReason>sample string 1</statusReason>
</ProspectResponse>

multipart/form-data

Sample:

<ProspectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><prospectDetails><comments>sample string 8</comments><company>sample string 6</company><email>sample string 4</email><firstName>sample string 2</firstName><garages>16</garages><ireProspectID>1</ireProspectID><jobTitle>sample string 7</jobTitle><lastName>sample string 3</lastName><maxBaths>13</maxBaths><maxBeds>11</maxBeds><maxPrice>15.1</maxPrice><minBaths>12</minBaths><minBeds>10</minBeds><minPrice>14.1</minPrice><mobile>sample string 5</mobile><moveInDate>sample string 9</moveInDate><petsAllowed>1</petsAllowed><prospectsource>sample string 18</prospectsource><suburbs>sample string 17</suburbs><type>Rental</type></prospectDetails><status>Ok</status><statusReason>sample string 1</statusReason></ProspectResponse>