/v3/diary/{shortName}/allocations

Get a list of all available allocations for a date + 7 days for a specified appointment type

• shortName (path, required) — The unique client short-name
• preferredDate (query, required) — The date to search from
• appointmentType (query, required) — The unique appointment type identifier
• lettings (query) — Sales or Lettings property?
• propertyIdentifier (query) — The unique property identifier (Sales or Lettings) determines branch and property type
• branchID (query) — Branch ID to check appointments (required if no property submitted)

/v3/diary/{shortName}/appointment

Delete an existing appointment using its unique identifier

• shortName (path, required) — The unique client short-name
• appointmentID (query, required) — The unique appointment id

/v3/diary/{shortName}/appointment

Get an appointment by ID

• shortName (path, required) — Company short name
• appointmentID (query, required) — Appointment ID

/v3/diary/{shortName}/appointment

Post an appointment into a valid diary allocation

• shortName (path, required) — The unique client short-name
• propertyIdentifier (query, required) — The unique property identifier (Sales or Lettings)
• lettings (query) — Sales or Lettings property?

/v3/diary/{shortName}/appointment

Update an existing appointment using its unique identifier

• shortName (path, required) — The unique client short-name
• appointmentID (query, required) — The unique appointment id
• lettings (query) — Sales or Lettings property?
• AllowMarketingCorrespondence (query) — Sales or Lettings property?

/v3/diary/{shortName}/appointment/feedback

Submit appointment feedback

• shortName (path, required) — The unique client short-name

/v3/diary/{shortName}/appointment/{appointmentID}/cancel

Cancel an existing appointment using its unique identifier

• shortName (path, required) — The unique client short-name
• appointmentID (path, required) — The unique appointment id

/v3/diary/{shortName}/appointmentsbetweendates

A collection of diary appointments linked to a company filtered between specific dates and by appointment type

• shortName (path, required) — The unique client short-name
• branchID (query, required) — The unique ID of the Branch
• startDate (query, required) — The search from date
• endDate (query, required) — The search to date
• appointmentTypesToSearch (query, required) — The appointment IDs to search for
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v3/diary/{shortName}/appointmenttypes

A collection of all diary appointment types

• shortName (path, required) — The unique client short-name
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v3/diary/{shortName}/company/branches

All branches defined for a company

• shortName (path, required) — The unique client short-name
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v3/diary/{shortName}/company/branches/{branchID}

Get a specific branch given its unique Object ID (OID)

• shortName (path, required) — The unique client short-name
• branchID (path, required) — The unique ID of the Branch

/v3/diary/{shortName}/recurringappointment

Retrieves all recurring appointments:-

• shortName (path, required) — The unique client short-name
• branchID (query, required) — The unique ID of the Branch
• appointmentTypesToSearch (query, required) — The appointment IDs to search for
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v3/diary/{shortname}/{branchID}/guest/search

Match Guest Parameters with existing applicants

• shortname (path, required)
• branchID (path, required)
• forename (query, required)
• emailaddress (query, required)
• surname (query, required)
• offset (query, required, offset)
• count (query, required, limit)