MyHome.ie Data Delivery Service

<back to all web services

BookFeatureSpotRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/featuredspot/book
BookFeatureSpotRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdbodyintNo
FeaturedSpotbodyFeaturedSpotNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
FeaturedSpot Parameters:
NameParameterData TypeRequiredDescription
FeaturedSpotIdformintNo
FeaturedSpotTypeIdformintNo
ProductIdformintNo
OrderIdformintNo
GroupIdformintNo
PropertyIdformint?No
StartDateformDateTimeNo
EndDateformDateTime?No
LocalityIdformint?No
PropertyClassIdformint?No
CreatedByUserIdformintNo
CreatedOnformDateTimeNo
ModifiedOnformDateTimeNo
EventStartsOnformDateTime?No
EventEndsOnformDateTime?No
CustomJsonformstringNo
MinPriceformdecimal?No
MaxPriceformdecimal?No
MinBedsformshort?No
MaxBedsformshort?No
PropertyTypeIdformint?No
BookFeaturedSpotResponse Parameters:
NameParameterData TypeRequiredDescription
FeaturedProductformFeaturedSpotNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BaseType Parameters:
NameParameterData TypeRequiredDescription
VersionformdoubleNo

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.

POST /featuredspot/book HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserId":0,"FeaturedSpot":{"FeaturedSpotId":0,"FeaturedSpotTypeId":0,"ProductId":0,"OrderId":0,"GroupId":0,"PropertyId":0,"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","LocalityId":0,"PropertyClassId":0,"CreatedByUserId":0,"CreatedOn":"0001-01-01T00:00:00.0000000","ModifiedOn":"0001-01-01T00:00:00.0000000","EventStartsOn":"0001-01-01T00:00:00.0000000","EventEndsOn":"0001-01-01T00:00:00.0000000","CustomJson":"String","MinPrice":0,"MaxPrice":0,"MinBeds":0,"MaxBeds":0,"PropertyTypeId":0},"ApiKey":"String","CorrelationId":"String","ActiveUserId":0,"Version":0,"RequestTypeId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FeaturedProduct":{"FeaturedSpotId":0,"FeaturedSpotTypeId":0,"ProductId":0,"OrderId":0,"GroupId":0,"PropertyId":0,"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","LocalityId":0,"PropertyClassId":0,"CreatedByUserId":0,"CreatedOn":"0001-01-01T00:00:00.0000000","ModifiedOn":"0001-01-01T00:00:00.0000000","EventStartsOn":"0001-01-01T00:00:00.0000000","EventEndsOn":"0001-01-01T00:00:00.0000000","CustomJson":"String","MinPrice":0,"MaxPrice":0,"MinBeds":0,"MaxBeds":0,"PropertyTypeId":0},"Version":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}