Update Holiday Listing

HTTP Request

PATCHhttps://staging.api-gw.propdata.net/listings/api/v1/holiday/{id}/

Example Response

{
"id": 0,
"site": 0,
"area": 0,
"meta": {},
"web_ref": "string",
"model": "string",
"created": "2021-03-01T14:10:09.143Z",
"modified": "2021-03-01T14:10:09.143Z",
"deleted": "2021-03-01T14:10:09.143Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"branch": -2147483648,
"agent": -2147483648,
"agent_2": -2147483648,
"agent_3": -2147483648,
"agent_4": -2147483648,
"poa": false,
"owner_viewing_arrangements": "string",
"location": -2147483648,
"is_custom_location": false,
"unit_number": "string",
"street_number": "string",
"street_name": "string",
"mapping_option": "string",
"complex_name": "string",
"publish_street_address": false,
"marketing_heading": "string",
"description": "string",
"map_image": -2147483648,
"map_x_position": "string",
"map_y_position": "string",
"team": -2147483648,
"display_on_website": false,
"feature_on_newsletter": false,
"feature_on_agent_newsletter": false,
"featured": false,
"header_images": [],
"listing_images": [],
"floor_plans": [],
"documents": [],
"private_documents": [],
"on_show": false,
"on_show_directions": "string",
"on_show_date": "string",
"on_show_every_saturday": false,
"on_show_every_sunday": false,
"on_show_start_time": "string",
"on_show_end_time": "string",
"owners": [],
"tenant": -2147483648,
"tenant_lease_ends": "string",
"tenant_notice_period": "string",
"tenant_rental": -2147483648,
"tenant_notes": "string",
"owner_notes": "string",
"deposit": -2147483648,
"lightstone_id": -2147483648,
"lightstone_data": null,
"building_name": "string",
"erf_number": "string",
"feed_to_portals": false,
"matterport_id": "string",
"video_id": "string",
"virtual_tour": "http://www.example.com",
"external_link_name": "string",
"external_link_url": "string",
"property_title": "string",
"developer": "string",
"build_year": -2147483648,
"build_completion_status": "string",
"property_permit": "string",
"brochures": [],
"status": "string",
"listing_type": "string",
"property_type": "string",
"establishment_name": "string",
"establishment_notes": "string",
"special_offer": false,
"special_offer_description": "string",
"special_offer_start_date": "string",
"special_offer_end_date": "string",
"bedrooms": "0.00",
"sleeps": "0.00",
"king_beds": "0.00",
"queen_beds": "0.00",
"double_beds": "0.00",
"bunk_beds": "0.00",
"single_beds": "0.00",
"linen_provided": false,
"bathrooms": "0.00",
"baths": 0,
"showers": 0,
"hand_showers": 0,
"towels_provided": false,
"lounge": "0.00",
"dining_room": "0.00",
"air_conditioning": false,
"ceiling_fans": false,
"standing_fans": false,
"dstv": "string",
"fridge": false,
"microwave": false,
"oven": false,
"washing_machine": false,
"tumble_dryer": false,
"dishwasher": false,
"crockery": false,
"garden": "string",
"braai": "string",
"pool": "string",
"jacuzzi": "string",
"undercover_parking_bays": 0,
"open_parking_bays": 0,
"parking_note": "string",
"garages": 0,
"peak_season": "0.00",
"semi_season": "0.00",
"low_season": "0.00",
"out_of_season": "0.00",
"corporate_rate": "0.00",
"credit_cards_accepted": [],
"booking_notes": "string",
"floor": "string",
"sea_views": "string",
"cleaning_service": "string",
"extras": "string",
"statistics": 0
}

NameDescription

id

required

integer

id of Record

NameDescription

id

integer

ID

site

integer

Site

area

integer

Area

meta

string

Meta

web_ref

stringnon-empty

Web ref

model

stringnon-empty

Model

created

string

Created

modified

string

Modified

deleted

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

branch

required

integer

Branch - The Branch ID this listing is assigned to

agent

required

integer

Agent - The agent ID of the primary listing agent

agent_2

nullable

integer

Agent 2 - The agent ID of the second listing agent

agent_3

nullable

integer

Agent 3 - The agent ID of the third listing agent

agent_4

nullable

integer

Agent 4 - The agent ID of the fourth listing agent

poa

boolean

Poa - Whether the listing price is available on request

owner_viewing_arrangements

nullable

string

Owner viewing arrangements

location

required

integer

Location

is_custom_location

boolean

Is custom location

unit_number

nullable

string<= 10 characters

Unit number

street_number

nullable

string<= 10 characters

Street number

street_name

nullable

string<= 100 characters

Street name

mapping_option

nullable

string

Mapping option

Choices: AddressSuburb

complex_name

nullable

string<= 60 characters

Complex name

publish_street_address

boolean

Publish street address

marketing_heading

nullable

string<= 100 characters

Marketing heading

description

nullable

string

Description

map_image

nullable

integer

Map image

map_x_position

nullable

string<= 50 characters

Map x position

map_y_position

nullable

string<= 50 characters

Map y position

team

nullable

integer

Team

display_on_website

boolean

Display on website

feature_on_newsletter

boolean

Feature on newsletter

feature_on_agent_newsletter

boolean

Feature on agent newsletter

featured

boolean

Featured

header_images

nullable

array of integers

Header images

Choices: [ 1,2,3...2147483648 ]

listing_images

nullable

array of integers

Listing images

Choices: [ 1,2,3...2147483648 ]

floor_plans

nullable

array of integers

Floor plans

Choices: [ 1,2,3...2147483648 ]

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

private_documents

nullable

array of integers

Private documents

Choices: [ 1,2,3...2147483648 ]

on_show

boolean

On show

on_show_directions

nullable

string

On show directions

on_show_date

nullable

string

On show date

on_show_every_saturday

boolean

On show every saturday

on_show_every_sunday

boolean

On show every sunday

on_show_start_time

nullable

string

On show start time

on_show_end_time

nullable

string

On show end time

owners

nullable

array of integers

Owners

Choices: [ 1,2,3...2147483648 ]

tenant

nullable

integer

Tenant

tenant_lease_ends

nullable

string

Tenant lease ends

tenant_notice_period

nullable

string<= 50 characters

Tenant notice period

tenant_rental

nullable

integer

Tenant rental

tenant_notes

nullable

string

Tenant notes

owner_notes

nullable

string

Owner notes

deposit

nullable

integer

Deposit

lightstone_id

nullable

integer

Lightstone id

lightstone_data

nullable

object

Lightstone data

building_name

nullable

string<= 60 characters

Building name

erf_number

nullable

string<= 40 characters

Erf number

feed_to_portals

boolean

Feed to portals

matterport_id

nullable

string<= 100 characters

Matterport id

video_id

nullable

string<= 30 characters

Video id

virtual_tour

nullable

string<= 150 characters

Virtual tour

external_link_name

nullable

string<= 20 characters

External link name

external_link_url

nullable

string<= 200 characters

External link url

property_title

nullable

string

Property title

Choices: Sectional TitleFreeholdShare BlockLeasehold

developer

nullable

string<= 50 characters

Developer

build_year

nullable

integer

Build year

build_completion_status

nullable

string

Build completion status

Choices: CompletedOff Plan

property_permit

nullable

string<= 50 characters

Property permit

brochures

nullable

array of integers

Brochures

Choices: [ 1,2,3...2147483648 ]

status

required

string

Status

Choices: ActiveArchived

listing_type

required

string

Listing type

Choices: Holiday Letting

property_type

required

string

Property type

Choices: FarmApartmentDuplexChaletFlatGarden CottageHouseSimplexTownhouseVilla

establishment_name

required

string[ 1...100 ] characters

Establishment name

establishment_notes

required

stringnon-empty

Establishment notes

special_offer

boolean

Special offer

special_offer_description

nullable

string

Special offer description

special_offer_start_date

nullable

string

Special offer start date

special_offer_end_date

nullable

string

Special offer end date

bedrooms

required

string

Bedrooms

sleeps

required

string

Sleeps

king_beds

required

string

King beds

queen_beds

required

string

Queen beds

double_beds

required

string

Double beds

bunk_beds

required

string

Bunk beds

single_beds

required

string

Single beds

linen_provided

boolean

Linen provided

bathrooms

required

string

Bathrooms

baths

required

integer

Baths

Choices: 1234567891011121314151617181920

showers

required

integer

Showers

Choices: 1234567891011121314151617181920

hand_showers

required

integer

Hand showers

Choices: 1234567891011121314151617181920

towels_provided

boolean

Towels provided

lounge

required

string

Lounge

dining_room

required

string

Dining room

air_conditioning

boolean

Air conditioning

ceiling_fans

boolean

Ceiling fans

standing_fans

boolean

Standing fans

dstv

nullable

string

Dstv

Choices: YesYes (Bring Your Own Smart Card)Yes (Bring Your Own Decoder)No

fridge

boolean

Fridge

microwave

boolean

Microwave

oven

boolean

Oven

washing_machine

boolean

Washing machine

tumble_dryer

boolean

Tumble dryer

dishwasher

boolean

Dishwasher

crockery

boolean

Crockery

garden

required

string

Garden

Choices: PrivateCommunalNo

braai

required

string

Braai

Choices: Both Gas and CharcoalBuilt-InCharcoal - Built-inCharcoal - PortableCommunalGas - Built-inGas - PortableNonePortablePrivate

pool

required

string

Pool

Choices: CommunalNonePool with netPrivateSplash poolSplash pool with net

jacuzzi

required

string

Jacuzzi

Choices: PrivateCommunalNo

undercover_parking_bays

required

integer

Undercover parking bays

Choices: 1234567891011121314151617181920

open_parking_bays

required

integer

Open parking bays

Choices: 1234567891011121314151617181920

parking_note

nullable

string

Parking note

garages

nullable

integer

Garages

Choices: 1234567891011121314151617181920

peak_season

required

string

Peak season

semi_season

required

string

Semi season

low_season

required

string

Low season

out_of_season

required

string

Out of season

corporate_rate

nullable

string

Corporate rate

credit_cards_accepted

nullable

array of strings

Credit cards accepted

Choices: VisaMastercardAmerican ExpressDiners Club

booking_notes

nullable

string

Booking notes

floor

required

string

Floor

Choices: N/ASingle StoreyDouble StoreyTriple StoryGround Floor1 Floor2 Floor3 Floor4 Floor5 Floor6 Floor7 Floor8 Floor9 Floor10 Floor11 Floor12 Floor13 Floor14 Floor15 Floor16 Floor17 Floor18 Floor19 Floor20 Floor21 Floor22 Floor23 Floor24 Floor25 Floor26 Floor27 Floor28 Floor29 Floor30 Floor31 Floor32 Floor33 Floor34 Floor35 Floor36 Floor37 Floor38 Floor39 Floor40 Floor41 Floor42 Floor43 Floor44 Floor45 Floor46 Floor47 Floor48 Floor49 Floor50 Floor

sea_views

required

string

Sea views

Choices: NonePartialSide ViewFull FrontalBreaker Sea ViewDistantGoodFull Frontal Sea ViewDistant Sea ViewPartial Sea ViewForest ViewMountain ViewInland ViewGolf Course ViewView over ZimbaliSea and Forest ViewsGolf Course and Sea ViewsDriving Range Views

cleaning_service

required

string

Cleaning service

Choices: Monday - FridayMonday - SaturdayOnce a WeekOn RequestNot Serviced

extras

nullable

string

Extras

statistics

nullable

integer

Statistics

Responses

200
400 Bad request body
403 You do not have permission to perform this action
404 Not found
500 Internal server error
503 This website is not active