POST v1/times
Request Information
URI Parameters
None.
Body Parameters
TimesRequestName | Description | Type | Additional information |
---|---|---|---|
apiKey | string |
None. |
|
portal | PropertyPortals |
None. |
|
portalAgentID | string |
None. |
|
agentName | string |
None. |
|
property | PortalProperty |
None. |
Request Formats
application/json, text/json
Sample:
{ "apiKey": "sample string 1", "portal": 0, "portalAgentID": "sample string 2", "agentName": "sample string 3", "property": { "propertyID": "sample string 1", "agentPropertyID": "sample string 2", "address": { "streetNo": "sample string 1", "street": "sample string 2", "suburb": "sample string 3", "postCode": "sample string 4" }, "listingAgents": [ { "id": 1, "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "mobile": "sample string 5" }, { "id": 1, "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "mobile": "sample string 5" } ], "availableDate": "sample string 3", "price": 4.1, "displayPrice": "sample string 5", "propType": 0, "openTimes": [ { "startTime": "sample string 1", "endTime": "sample string 2" }, { "startTime": "sample string 1", "endTime": "sample string 2" } ] } }
application/xml, text/xml
Sample:
<TimesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"> <agentName>sample string 3</agentName> <apiKey>sample string 1</apiKey> <portal>None</portal> <portalAgentID>sample string 2</portalAgentID> <property> <address> <postCode>sample string 4</postCode> <street>sample string 2</street> <streetNo>sample string 1</streetNo> <suburb>sample string 3</suburb> </address> <agentPropertyID>sample string 2</agentPropertyID> <availableDate>sample string 3</availableDate> <displayPrice>sample string 5</displayPrice> <listingAgents> <ListingAgent> <email>sample string 4</email> <firstName>sample string 2</firstName> <id>1</id> <lastName>sample string 3</lastName> <mobile>sample string 5</mobile> </ListingAgent> <ListingAgent> <email>sample string 4</email> <firstName>sample string 2</firstName> <id>1</id> <lastName>sample string 3</lastName> <mobile>sample string 5</mobile> </ListingAgent> </listingAgents> <openTimes> <Time> <endTime>sample string 2</endTime> <startTime>sample string 1</startTime> </Time> <Time> <endTime>sample string 2</endTime> <startTime>sample string 1</startTime> </Time> </openTimes> <price>4.1</price> <propType>Rental</propType> <propertyID>sample string 1</propertyID> </property> </TimesRequest>
multipart/form-data
Sample:
<TimesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><agentName>sample string 3</agentName><apiKey>sample string 1</apiKey><portal>None</portal><portalAgentID>sample string 2</portalAgentID><property><address><postCode>sample string 4</postCode><street>sample string 2</street><streetNo>sample string 1</streetNo><suburb>sample string 3</suburb></address><agentPropertyID>sample string 2</agentPropertyID><availableDate>sample string 3</availableDate><displayPrice>sample string 5</displayPrice><listingAgents><ListingAgent><email>sample string 4</email><firstName>sample string 2</firstName><id>1</id><lastName>sample string 3</lastName><mobile>sample string 5</mobile></ListingAgent><ListingAgent><email>sample string 4</email><firstName>sample string 2</firstName><id>1</id><lastName>sample string 3</lastName><mobile>sample string 5</mobile></ListingAgent></listingAgents><openTimes><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time><Time><endTime>sample string 2</endTime><startTime>sample string 1</startTime></Time></openTimes><price>4.1</price><propType>Rental</propType><propertyID>sample string 1</propertyID></property></TimesRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RegisterResponseName | Description | 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>