POST v1/book/unsub

Request Information

URI Parameters

None.

Body Parameters

BookingRequest
NameDescriptionTypeAdditional information
RequestType

BookingRequestType

None.

PropertyIDType

PropertyIDType

None.

PropertyID

string

None.

PropertyFeedID

string

None.

PropertyPortalID

string

None.

EnquiryIDType

EnquiryIDType

None.

EnquiryID

string

None.

EnquirySource

string

None.

ProspectDetails

ProspectDetails

None.

PortalID

PropertyPortals

None.

SelectedTime

SpecificTime

None.

ApiUserID

string

None.

ApiKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestType": 0,
  "PropertyIDType": 0,
  "PropertyID": "sample string 1",
  "PropertyFeedID": "sample string 2",
  "PropertyPortalID": "sample string 3",
  "EnquiryIDType": 0,
  "EnquiryID": "sample string 4",
  "EnquirySource": "sample string 5",
  "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"
  },
  "PortalID": 0,
  "SelectedTime": {
    "day": "sample string 1",
    "time": {
      "startTime": "sample string 1",
      "endTime": "sample string 2"
    }
  },
  "ApiUserID": "sample string 6",
  "ApiKey": "sample string 7"
}

application/xml, text/xml

Sample:
<BookingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.Booking">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 7</ApiKey>
  <ApiUserID xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 6</ApiUserID>
  <EnquiryID>sample string 4</EnquiryID>
  <EnquiryIDType>None</EnquiryIDType>
  <EnquirySource>sample string 5</EnquirySource>
  <PortalID>None</PortalID>
  <PropertyFeedID>sample string 2</PropertyFeedID>
  <PropertyID>sample string 1</PropertyID>
  <PropertyIDType>None</PropertyIDType>
  <PropertyPortalID>sample string 3</PropertyPortalID>
  <ProspectDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models">
    <d2p1:comments>sample string 8</d2p1:comments>
    <d2p1:company>sample string 6</d2p1:company>
    <d2p1:email>sample string 4</d2p1:email>
    <d2p1:firstName>sample string 2</d2p1:firstName>
    <d2p1:ireProspectID>1</d2p1:ireProspectID>
    <d2p1:jobTitle>sample string 7</d2p1:jobTitle>
    <d2p1:lastName>sample string 3</d2p1:lastName>
    <d2p1:mobile>sample string 5</d2p1:mobile>
    <d2p1:moveInDate>sample string 9</d2p1:moveInDate>
  </ProspectDetails>
  <RequestType>None</RequestType>
  <SelectedTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models">
    <d2p1:day>sample string 1</d2p1:day>
    <d2p1:time>
      <d2p1:endTime>sample string 2</d2p1:endTime>
      <d2p1:startTime>sample string 1</d2p1:startTime>
    </d2p1:time>
  </SelectedTime>
</BookingRequest>

multipart/form-data

Sample:
<BookingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.Booking"><ApiKey xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 7</ApiKey><ApiUserID xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 6</ApiUserID><EnquiryID>sample string 4</EnquiryID><EnquiryIDType>None</EnquiryIDType><EnquirySource>sample string 5</EnquirySource><PortalID>None</PortalID><PropertyFeedID>sample string 2</PropertyFeedID><PropertyID>sample string 1</PropertyID><PropertyIDType>None</PropertyIDType><PropertyPortalID>sample string 3</PropertyPortalID><ProspectDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models"><d2p1:comments>sample string 8</d2p1:comments><d2p1:company>sample string 6</d2p1:company><d2p1:email>sample string 4</d2p1:email><d2p1:firstName>sample string 2</d2p1:firstName><d2p1:ireProspectID>1</d2p1:ireProspectID><d2p1:jobTitle>sample string 7</d2p1:jobTitle><d2p1:lastName>sample string 3</d2p1:lastName><d2p1:mobile>sample string 5</d2p1:mobile><d2p1:moveInDate>sample string 9</d2p1:moveInDate></ProspectDetails><RequestType>None</RequestType><SelectedTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models"><d2p1:day>sample string 1</d2p1:day><d2p1:time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:time></SelectedTime></BookingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BookingResponse
NameDescriptionTypeAdditional information
IREPropertyID

integer

None.

AvailableTimes

Collection of AvailableTime

None.

IREEnquiryID

integer

None.

IREEnquiryGUID

globally unique identifier

None.

IREShortEnquiryID

string

None.

ProspectDetails

ProspectDetails

None.

RegisteredTime

SpecificTime

None.

Status

ResponseStatus

None.

StatusReason

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IREPropertyID": 1,
  "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"
        }
      ]
    }
  ],
  "IREEnquiryID": 2,
  "IREEnquiryGUID": "7b84a64d-81d9-497b-a8fc-e6eeaa0c2e95",
  "IREShortEnquiryID": "sample string 4",
  "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"
  },
  "RegisteredTime": {
    "day": "sample string 1",
    "time": {
      "startTime": "sample string 1",
      "endTime": "sample string 2"
    }
  },
  "Status": 1,
  "StatusReason": "sample string 5"
}

application/xml, text/xml

Sample:
<BookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.Booking">
  <Status xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">Ok</Status>
  <StatusReason xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 5</StatusReason>
  <AvailableTimes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models">
    <d2p1:AvailableTime>
      <d2p1:day>sample string 1</d2p1:day>
      <d2p1:times>
        <d2p1:Time>
          <d2p1:endTime>sample string 2</d2p1:endTime>
          <d2p1:startTime>sample string 1</d2p1:startTime>
        </d2p1:Time>
        <d2p1:Time>
          <d2p1:endTime>sample string 2</d2p1:endTime>
          <d2p1:startTime>sample string 1</d2p1:startTime>
        </d2p1:Time>
      </d2p1:times>
    </d2p1:AvailableTime>
    <d2p1:AvailableTime>
      <d2p1:day>sample string 1</d2p1:day>
      <d2p1:times>
        <d2p1:Time>
          <d2p1:endTime>sample string 2</d2p1:endTime>
          <d2p1:startTime>sample string 1</d2p1:startTime>
        </d2p1:Time>
        <d2p1:Time>
          <d2p1:endTime>sample string 2</d2p1:endTime>
          <d2p1:startTime>sample string 1</d2p1:startTime>
        </d2p1:Time>
      </d2p1:times>
    </d2p1:AvailableTime>
  </AvailableTimes>
  <IREEnquiryGUID>7b84a64d-81d9-497b-a8fc-e6eeaa0c2e95</IREEnquiryGUID>
  <IREEnquiryID>2</IREEnquiryID>
  <IREPropertyID>1</IREPropertyID>
  <IREShortEnquiryID>sample string 4</IREShortEnquiryID>
  <ProspectDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models">
    <d2p1:comments>sample string 8</d2p1:comments>
    <d2p1:company>sample string 6</d2p1:company>
    <d2p1:email>sample string 4</d2p1:email>
    <d2p1:firstName>sample string 2</d2p1:firstName>
    <d2p1:ireProspectID>1</d2p1:ireProspectID>
    <d2p1:jobTitle>sample string 7</d2p1:jobTitle>
    <d2p1:lastName>sample string 3</d2p1:lastName>
    <d2p1:mobile>sample string 5</d2p1:mobile>
    <d2p1:moveInDate>sample string 9</d2p1:moveInDate>
  </ProspectDetails>
  <RegisteredTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models">
    <d2p1:day>sample string 1</d2p1:day>
    <d2p1:time>
      <d2p1:endTime>sample string 2</d2p1:endTime>
      <d2p1:startTime>sample string 1</d2p1:startTime>
    </d2p1:time>
  </RegisteredTime>
</BookingResponse>

multipart/form-data

Sample:
<BookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.Booking"><Status xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">Ok</Status><StatusReason xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.ApiUser">sample string 5</StatusReason><AvailableTimes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models"><d2p1:AvailableTime><d2p1:day>sample string 1</d2p1:day><d2p1:times><d2p1:Time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:Time><d2p1:Time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:Time></d2p1:times></d2p1:AvailableTime><d2p1:AvailableTime><d2p1:day>sample string 1</d2p1:day><d2p1:times><d2p1:Time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:Time><d2p1:Time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:Time></d2p1:times></d2p1:AvailableTime></AvailableTimes><IREEnquiryGUID>7b84a64d-81d9-497b-a8fc-e6eeaa0c2e95</IREEnquiryGUID><IREEnquiryID>2</IREEnquiryID><IREPropertyID>1</IREPropertyID><IREShortEnquiryID>sample string 4</IREShortEnquiryID><ProspectDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models"><d2p1:comments>sample string 8</d2p1:comments><d2p1:company>sample string 6</d2p1:company><d2p1:email>sample string 4</d2p1:email><d2p1:firstName>sample string 2</d2p1:firstName><d2p1:ireProspectID>1</d2p1:ireProspectID><d2p1:jobTitle>sample string 7</d2p1:jobTitle><d2p1:lastName>sample string 3</d2p1:lastName><d2p1:mobile>sample string 5</d2p1:mobile><d2p1:moveInDate>sample string 9</d2p1:moveInDate></ProspectDetails><RegisteredTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/IRE.API.Models"><d2p1:day>sample string 1</d2p1:day><d2p1:time><d2p1:endTime>sample string 2</d2p1:endTime><d2p1:startTime>sample string 1</d2p1:startTime></d2p1:time></RegisteredTime></BookingResponse>