POST v1/register

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
apiKey	string	None.
portal	PropertyPortals	None.
requestType	RequestType	None.
irePropertyID	integer	None.
prospectDetails	ProspectDetails	None.
selectedTime	SpecificTime	None.
ireEnquiryID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "portal": 0,
  "requestType": 10,
  "irePropertyID": 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"
  },
  "selectedTime": {
    "day": "sample string 1",
    "time": {
      "startTime": "sample string 1",
      "endTime": "sample string 2"
    }
  },
  "ireEnquiryID": 3
}

application/xml, text/xml

Sample:

<RegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models">
  <apiKey>sample string 1</apiKey>
  <ireEnquiryID>3</ireEnquiryID>
  <irePropertyID>2</irePropertyID>
  <portal>None</portal>
  <prospectDetails>
    <comments>sample string 8</comments>
    <company>sample string 6</company>
    <email>sample string 4</email>
    <firstName>sample string 2</firstName>
    <ireProspectID>1</ireProspectID>
    <jobTitle>sample string 7</jobTitle>
    <lastName>sample string 3</lastName>
    <mobile>sample string 5</mobile>
    <moveInDate>sample string 9</moveInDate>
  </prospectDetails>
  <requestType>Register</requestType>
  <selectedTime>
    <day>sample string 1</day>
    <time>
      <endTime>sample string 2</endTime>
      <startTime>sample string 1</startTime>
    </time>
  </selectedTime>
</RegisterRequest>

multipart/form-data

Sample:

<RegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><apiKey>sample string 1</apiKey><ireEnquiryID>3</ireEnquiryID><irePropertyID>2</irePropertyID><portal>None</portal><prospectDetails><comments>sample string 8</comments><company>sample string 6</company><email>sample string 4</email><firstName>sample string 2</firstName><ireProspectID>1</ireProspectID><jobTitle>sample string 7</jobTitle><lastName>sample string 3</lastName><mobile>sample string 5</mobile><moveInDate>sample string 9</moveInDate></prospectDetails><requestType>Register</requestType><selectedTime><day>sample string 1</day><time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></time></selectedTime></RegisterRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegisterResponse

Name	Type	Additional information
status	ResponseStatus	None.
statusReason	string	None.
irePropertyID	integer	None.
availableTimes	Collection of AvailableTime	None.
prospectDetails	ProspectDetails	None.
ireEnquiryID	integer	None.
userRegisterLink	string	None.
registeredTime	SpecificTime	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "statusReason": "sample string 1",
  "irePropertyID": 2,
  "availableTimes": [
    {
      "day": "sample string 1",
      "times": [
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2"
        },
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2"
        }
      ]
    },
    {
      "day": "sample string 1",
      "times": [
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2"
        },
        {
          "startTime": "sample string 1",
          "endTime": "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"
  },
  "ireEnquiryID": 3,
  "userRegisterLink": "sample string 4",
  "registeredTime": {
    "day": "sample string 1",
    "time": {
      "startTime": "sample string 1",
      "endTime": "sample string 2"
    }
  }
}

application/xml, text/xml

Sample:

<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models">
  <availableTimes>
    <AvailableTime>
      <day>sample string 1</day>
      <times>
        <Time>
          <endTime>sample string 2</endTime>
          <startTime>sample string 1</startTime>
        </Time>
        <Time>
          <endTime>sample string 2</endTime>
          <startTime>sample string 1</startTime>
        </Time>
      </times>
    </AvailableTime>
    <AvailableTime>
      <day>sample string 1</day>
      <times>
        <Time>
          <endTime>sample string 2</endTime>
          <startTime>sample string 1</startTime>
        </Time>
        <Time>
          <endTime>sample string 2</endTime>
          <startTime>sample string 1</startTime>
        </Time>
      </times>
    </AvailableTime>
  </availableTimes>
  <ireEnquiryID>3</ireEnquiryID>
  <irePropertyID>2</irePropertyID>
  <prospectDetails>
    <comments>sample string 8</comments>
    <company>sample string 6</company>
    <email>sample string 4</email>
    <firstName>sample string 2</firstName>
    <ireProspectID>1</ireProspectID>
    <jobTitle>sample string 7</jobTitle>
    <lastName>sample string 3</lastName>
    <mobile>sample string 5</mobile>
    <moveInDate>sample string 9</moveInDate>
  </prospectDetails>
  <registeredTime>
    <day>sample string 1</day>
    <time>
      <endTime>sample string 2</endTime>
      <startTime>sample string 1</startTime>
    </time>
  </registeredTime>
  <status>Ok</status>
  <statusReason>sample string 1</statusReason>
  <userRegisterLink>sample string 4</userRegisterLink>
</RegisterResponse>

multipart/form-data

Sample:

<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><availableTimes><AvailableTime><day>sample string 1</day><times><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time></times></AvailableTime><AvailableTime><day>sample string 1</day><times><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time></times></AvailableTime></availableTimes><ireEnquiryID>3</ireEnquiryID><irePropertyID>2</irePropertyID><prospectDetails><comments>sample string 8</comments><company>sample string 6</company><email>sample string 4</email><firstName>sample string 2</firstName><ireProspectID>1</ireProspectID><jobTitle>sample string 7</jobTitle><lastName>sample string 3</lastName><mobile>sample string 5</mobile><moveInDate>sample string 9</moveInDate></prospectDetails><registeredTime><day>sample string 1</day><time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></time></registeredTime><status>Ok</status><statusReason>sample string 1</statusReason><userRegisterLink>sample string 4</userRegisterLink></RegisterResponse>