Skip to content

Push Property

Jump to bottom Edit New page
Andrew Jones edited this page May 16, 2023 · 45 revisions

Request:

  • Url /apis/property

  • Method POST

  • Content-Type application/json

  • Payload

  1. Specify "Id" in request payload to update existing property
  2. Remove "Id" field or specify null value for creating new property
  3. Partial update is supported. For example, payload { "Id": 8849, "Intro": "..." } will only update "Intro" field and leave all other field value it was.
  4. Image "Source" supports - url of image with public accessable and also base64 encoded string image content.
  5. Use "OwnerCompanyId" for linking to a existing owner. Specify the owner details on "OwnerCompany" for creating new. "OwnerCompanyId" is prior when both "OwnerCompanyId" and "OwnerCompany" have value.
  6. Use "AssignedContacts": [{ "ContactId": 3423 }, { "ContactId": 6216 }] for linking to existing contacts and specify contact details for creating new.
  7. Reviews "Rating" must be between 0 and 5. It's a optional field. Remove it or specify null value if you don't have rating.
  8. Amenities If you push an amenity that does not exist within the CMS, then it will be automatically created
{
  "Id": 8849,
  "ExternalId": "4A030B2BDDE0",
  "OwnerCompanyId": null,
  "OwnerCompany": {
    "ExternalId": "B65CCE2B239D",
    "Title": "Mr",
    "FirstName": "Fred",
    "LastName": "Chin",
    "Email": "fred.chin@test.com",
    "Email1": "",
    "Email2": "",
    "Mobile": "",
    "AltPhone": "",
    "Telephone": "",
    "Address": "",
    "Address1": "",
    "Postcode": "",
    "County": "",
    "City": "",
    "Country": "",
    "CompanyName": "",
    "Signature": "",
    "Source": "",
    "Comments": "",
    "ByPost": false,
    "ByEmail": false,
    "ByTelephone": false,
    "BySms": false,
    "AddedToBlacklist": false,
    "OnEmailList": false,
    "IsArchived": false,
    "BankName": "",
    "BankAccountName": "",
    "BankAccountNumber": "",
    "BankAddress": "",
    "BankAddress1": "",
    "BankCountry": "",
    "BankCounty": "",
    "BankCity": "",
    "BankPostcode": "",
    "BankSortCode": "",
    "BankReference": "",
    "BankPaymentReference": "",
    "IdNumber": "",
    "BankVatRegistered": null,
    "BankNonResident": null
  },
  "Name": "Casa Jade",
  "PropertyName": "Casa Jade",
  "Title": "Casa Jade",
  "Suspended": false,
  "Withdrawn": false,
  "HideOnWebsite": false,
  "DisableOnlineBooking": true,
  "PropertyReference": "1",
  "ContractRenewalDate": "",
  "PropertyWebsite": "",
  "Intro": "5 bedroom 3 bathroom luxury Villa, with fully heated swimming pool in Adeje Tenerife. This Villa has everything you would need in a Luxurious Setting. The 2 King-Size Master bedrooms are spacious with there own private balconies and have views of the mountains, pool and surrounding areas.",
  "MainDescription": "<p>Casa Jade is a Stunning Modern built Villa, set over 2 storeys\r\nand&nbsp; is situated within a Quiet Residential area that\r\noverlooks the fabulous Del Duque Coastline. This Villa still\r\nretains a more traditional theme, with Quality Furnishings and\r\nFurniture throughout.&nbsp; There are typical ceramic terraces,\r\nfront and rear for sun-bathing and the Pool is completely\r\nsurrounded by synthetic grass for comfort and safety.<br />\r\n<br />\r\n This Villa is fully equipped with everything you would need for\r\nyour stay in a Spacious and Relaxing atmosphere.&nbsp; All bedrooms\r\nare large, two with en-suite and two with balcony terraces enjoying\r\nviews of the pool and coast. Great for families and couples who\r\nneed to be near all the amenities and the beach.<br />\r\n<br />\r\n The Heated Swimming Pool (October onwards) is a generous size, 8\r\nmetres x 5 metres with ample sunbeds and seating for Al Fresco\r\ndining.<br />\r\n<br />\r\n The 'Gran Sur Shopping Complex' is nearby with Bars, Restaurants,\r\nShops, Supermarket and Taxi Rank and Local Shop is only a 3 minute\r\nwalk.</p>\r\n\r\n<p>&nbsp;</p>",
  "BrandId": null,
  "Currency": "€",
  "HideRates": false,
  "MinRate": 1395,
  "MaxRate": 1895,
  "RatesIncludeVat": true,
  "Commission": 200,
  "BreakagesDeposit": 200,
  "InternalRentalNotes": "internal rental notes",
  "AvailabilityNotes": "availability notes",
  "RentalNotesTitle": "Booking Notes",
  "RentalNotes": "<p><span><em>NB:Prices may be subject to change at the advertiser's\r\ndiscretion.</em></span></p>\r\n\r\n<p><span>The price is for the Villa and not per person.<em><br />\r\n</em></span></p>\r\n\r\n<p>A deposit will be required in advance for every booking. PayPal\r\navailable for the deposit if required, just ask when booking.\r\nCredit cards also accepted through PayPal (PayPal charges will\r\napply).</p>\r\n\r\n<p><br />\r\n <strong>Cancellation policy</strong>: The booking deposit is\r\nnon-refundable.</p>\r\n\r\n<p><br />\r\n <em>We only accept bookings for two weeks over the Christmas and\r\nNew Y</em>ear.</p>",
  "RentalNotesTitle1": "Booking Notes 1",
  "RentalNotes1": "<p><span><em>NB:Prices may be subject to change at the advertiser's\r\ndiscretion.</em></span></p>\r\n\r\n<p><span>The price is for the Villa and not per person.<em><br />\r\n</em></span></p>\r\n\r\n<p>A deposit will be required in advance for every booking. PayPal\r\navailable for the deposit if required, just ask when booking.\r\nCredit cards also accepted through PayPal (PayPal charges will\r\napply).</p>\r\n\r\n<p><br />\r\n <strong>Cancellation policy</strong>: The booking deposit is\r\nnon-refundable.</p>\r\n\r\n<p><br />\r\n <em>We only accept bookings for two weeks over the Christmas and\r\nNew Y</em>ear.</p>",
  "VirtualTourTitle": "",
  "VirtualTour": "",
  "Directions": "",
  "BrochurePage": null,
  "CheckInTimeFrom": "14:00",
  "CheckInTimeTo": "18:00",
  "CheckOutTimeUntil": "12:00",
  "KeySafeCode": "",
  "WifiCode": "",
  "OwnersCode": "",
  "OfficeCode": "",
  "PropertyNameTitle": "",
  "PropertySummary": "",
  "PropertyDescription": "",
  "RegionDescription": "",
  "LocationDescription": "",
  "OwnerListingStory": "",
  "Address": "Calle El Sauce C74 & 15",
  "Address2": "Costa Adeje",
  "City": "Tenerife",
  "County": "Canary Islands",
  "Postcode": "1",
  "Country": "Spain",
  "OwnerPropertyName": "",
  "Url": "/tenerife/costa-adeje/casa-jade/",
  "GeoLocation": "28.0940528753818,-16.72355090831229,19",
  "Pros": "Property Pros",
  "Cons": "Property Cons",
  "BuildSize": "",
  "PlotSize": "",
  "Licence": "",
  "LicenceExpiryDate": "",
  "Warnings": "",
  "Location": [
    "Tenerife",
    "Costa Adeje"
  ],
  "TrustPilotTag": "Trust Pilot Tag",
  "SEOTitle": "Casa Jade",
  "SEOKeywords": "Casa Jade",
  "SEODescription": "Casa Jade",
  "Attributes": {
    "Property Type": [
      "Villa"
    ],
    "Theme": [
      "Golf",
      "Family",
      "Luxury",
      "Beach"
    ],
    "Distances": [
      "Walking Distance to Beach",
      "Walking Distance to Bars/Restaurants",
      "Walking Distance to Taxi Rank"
    ],
    "Amenities": [
      "BBQ",
      "Internet Access",
      "DVD Player",
      "Stereo System",
      "Air Conditioning",
      "Sea Views",
      "Table Tennis",
      "Wi-Fi",
      "Full UK TV- ie BBC & Itv Etc",
      "Flat Screen TV",
      "Garden Furniture",
      "Cot Available",
      "High Chair",
      "Safe",
      "ipod Docking Station"
    ],
    "Kitchen Amenities": [
      "Fridge",
      "Fridge/Freezer",
      "Washing Machine",
      "Microwave",
      "Dishwasher",
      "Cooker & Hob",
      "Coffee Machine",
      "Toaster & Kettle",
      "Iron & Board"
    ],
    "Living Area": [
      "Seating for 8 People"
    ],
    "Bedroom Types": [
      "2 Double beds",
      "4 x Twin Beds"
    ],
    "Bedrooms": [
      "4"
    ],
    "Activities": [
      "Golf",
      "Cycling",
      "Watersports",
      "Places of Interest",
      "Diving Snorkelling",
      "Waterpark",
      "Restaurants",
      "Bars",
      "Nightlife",
      "Supermarkets",
      "Shopping"
    ],
    "Suitability": [
      "Children Welcome",
      "Children Welcome over the age of 10",
      "Elderly Friendly Properties"
    ],
    "Bathrooms": [
      "6"
    ],
    "Sleeps": [
      "4"
    ],
    "Swimming Pool": [
      "Private",
      "Heated"
    ],
    "Local Area": [
      "Local Shop"
    ],
    "Nearest Airport": [
      "Tenerife South"
    ],
    "Security Deposit Required": [
      "¡ê200 GBP"
    ],
    "Rental Agreement Type": [
      "Guaranteed Rental"
    ]
  },
  "Rooms": [
    {
      "Sleeps": null,
      "RoomNumbers": [
        {
          "Number": "dddd",
          "Notes": "ddd"
        }
      ],
      "Id": 10303,
      "NodeName": "Double Bedroom With Sea View",
      "Name": "Double Bedroom With Sea View",
      "Description": "Lovely double bedrooms with everything you need",
      "Amenities": [
        "BED LINEN & TOWELS",
        "ALARM CLOCK",
        "CUPBOARD",
        "DOUBLE BED",
        "BUILT-IN WARDROBES",
        "NIGHT TABLES",
        "READING LAMPS",
        "BALCONY",
        "SATELLITE TV",
        "AIR CONDITIONING"
      ],
      "Type": 0
    },
    {
      "Sleeps": null,
      "RoomNumbers": [
        {
          "Number": "aaaa",
          "Notes": "aaaa"
        }
      ],
      "Id": 10304,
      "NodeName": "Bedroom2",
      "Name": "",
      "Description": "",
      "Amenities": [
        "DOUBLE BED"
      ],
      "Type": 0
    },
    {
      "Sleeps": null,
      "RoomNumbers": [
        {
          "Number": "yyy",
          "Notes": "yyy"
        }
      ],
      "Id": 10305,
      "NodeName": "Bedroom3",
      "Name": "",
      "Description": "",
      "Amenities": [
        "DOUBLE BED"
      ],
      "Type": 0
    },
    {
      "Sleeps": null,
      "RoomNumbers": [],
      "Id": 10306,
      "NodeName": "Bedroom4",
      "Name": "",
      "Description": "",
      "Amenities": [
        "DOUBLE BED"
      ],
      "Type": 0
    },
    {
      "RoomType": "LIVING ROOM",
      "Id": 10488,
      "NodeName": "Explore",
      "Name": "Outside Space",
      "Description": "Lovely garden and pool area",
      "Amenities": [
        "SOFA"
      ],
      "Type": 1
    },
    {
      "RoomType": "LIVING ROOM",
      "Id": 10507,
      "NodeName": "Cinema Room",
      "Name": "Large Cinema Room",
      "Description": "Massive wide screen",
      "Amenities": [
        "SOFA"
      ],
      "Type": 1
    },
    {
      "RoomType": "BATHROOM",
      "Id": 10883,
      "NodeName": "Bathroom",
      "Name": "",
      "Description": "",
      "Amenities": [
        "TOILET"
      ],
      "Type": 1
    },
    {
      "RoomType": "",
      "Id": 12823,
      "NodeName": "Outside Space",
      "Name": "Outside Space",
      "Description": "Lovely garden and pool area",
      "Amenities": [
        "SOFA"
      ],
      "Type": 1
    },
    {
      "RoomType": "",
      "Id": 12824,
      "NodeName": "Large Cinema Room",
      "Name": "Large Cinema Room",
      "Description": "Massive wide screen",
      "Amenities": [
        "SOFA"
      ],
      "Type": 1
    }
  ],
  "Distances": [
    {
      "Name": "Beach xyz",
      "Distance": "10",
      "DistanceUnit": "MINUTES WALK",
      "DistanceType": "BEACH"
    },
    {
      "Name": "Lake",
      "Distance": "1",
      "DistanceUnit": "MINUTES WALK",
      "DistanceType": "BEACH"
    }
  ],
  "Images": [
    {
      "Id": "googlelogo_color_272x92dp",
      "Name": "Google Logo",
      "Source": "https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png"
    }
  ],
  "AssignedContacts": [
    {
      "ContactId": null,
      "ContactType": "KeyHolder",
      "ExternalId": "007F0D60477E",
      "Title": "Mr",
      "FirstName": "Steve",
      "LastName": "Long",
      "Email": "steve.long@test.com",
      "Email1": "",
      "Email2": "",
      "Mobile": "",
      "AltPhone": "",
      "Telephone": "",
      "Address": "",
      "Address1": "",
      "Postcode": "",
      "County": "",
      "City": "",
      "Country": "",
      "CompanyName": "",
      "Signature": "",
      "Source": "",
      "Comments": "",
      "ByPost": false,
      "ByEmail": false,
      "ByTelephone": false,
      "BySms": false,
      "AddedToBlacklist": false,
      "OnEmailList": false,
      "IsArchived": false
    }
  ],
  "Reviews": [
    {
      "Title": "Good",
      "Description": "Experience is very good",
      "Reviewer": "Steve",
      "Rating": 0.5,
      "ManagementComments": "Thank you!",
      "Published": true,
      "PublishedDate": "2020-06-13 11:02:05"
    }
  ]
}

Response:

  • Content-Type application/json

  • Payload

{
  "PropertyId": 8849,
  "ExternalId": "4A030B2BDDE0",
  "PropertyName": "Casa Jade",
  "PropertyReference": "1",
  "Success": true,
  "Logs": [
    "..."
  ]
}

Error Response:

  • Content-Type application/json

  • Payload

{
  "Success": false,
  "Message": "..."
}
Add a custom footer
Clone this wiki locally