MyHome.ie Data Delivery Service

<back to all web services

UpdateVirtualViewingRequest

Requires Authentication
The following routes are available for this service:
PUT/property/virtualviewing
UpdateVirtualViewingRequest Parameters:
NameParameterData TypeRequiredDescription
GroupIdbodyintNo
PropertyIdbodyintNo
PropertyClassIdbodyintNo
VirtualViewingbodyVirtualViewingNo
BaseDeliveryRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
VirtualViewing Parameters:
NameParameterData TypeRequiredDescription
FeaturedSpotIdformintNo
OrderIdformint?No
VirtualViewingStatusformVirtualViewingStatusNo
CallIdformstringNo
StartDateformDateTimeNo
EndDateformDateTimeNo
StartDateFormattedformstringNo
EndDateFormattedformstringNo
ResourceIdformstringNo
SIdformstringNo
GetVirtualViewingResponse Parameters:
NameParameterData TypeRequiredDescription
VirtualViewingformVirtualViewingNo

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

HTTP + CSV

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

PUT /property/virtualviewing HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GroupId":0,"PropertyId":0,"PropertyClassId":0,"VirtualViewing":{"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"},"SessionId":"String","ApiKey":"String","CorrelationId":"String","ActiveUserId":0,"Version":0,"RequestTypeId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"VirtualViewing":{"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"}}