MyHome.ie Data Delivery Service

<back to all web services

GetVirtualViewingsRequest

Requires Authentication
The following routes are available for this service:
POST/property/virtualviewings
GetVirtualViewingsRequest Parameters:
NameParameterData TypeRequiredDescription
PropertyIdbodyintNo
BaseDeliveryRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
GetVirtualViewingsResponse Parameters:
NameParameterData TypeRequiredDescription
VirtualViewingsformList<VirtualViewing>No
VirtualViewing Parameters:
NameParameterData TypeRequiredDescription
FeaturedSpotIdformintNo
OrderIdformint?No
VirtualViewingStatusformVirtualViewingStatusNo
CallIdformstringNo
StartDateformDateTimeNo
EndDateformDateTimeNo
StartDateFormattedformstringNo
EndDateFormattedformstringNo
ResourceIdformstringNo
SIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /property/virtualviewings HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PropertyId":0,"SessionId":"String","ApiKey":"String","CorrelationId":"String","ActiveUserId":0,"Version":0,"RequestTypeId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"VirtualViewings":[{"FeaturedSpotId":0,"OrderId":0,"VirtualViewingStatus":"Schedule","CallId":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","StartDateFormatted":"Mon Jan 1, 12am","EndDateFormatted":"Mon Jan 1, 12am","ResourceId":"String","SId":"String"}]}