v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Appointment Bookings

Search Lead Bookings

Returns a list of Appointment Bookings for a Lead, given a search query.

get/leads/{lead_id}/appointments/bookings/search

Path parameters

lead_idinteger required

Unique Lead ID.

Query parameters

qstring required

Search query. Refer to the "Using Search Functionality" section under the Guides tab for more information about building a query.

sortstring

Specifies the order in which the Lead list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Lead record list.

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

an UserException with Abort Transaction = Yes, and a Log Error = No
an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "lead_appointment_bookings": [
    {
      "booking_id": 1234567891234567,
      "lead_id": 1234567891234567,
      "appointment_id": 1234567891234567,
      "utc_appointment_start_datetime": "2014-12-31T23:59:59.938Z",
      "utc_appointment_end_datetime": "2014-12-31T23:59:59.938Z",
      "local_appointment_start_datetime": "2014-12-31T23:59:59.938Z",
      "local_appointment_end_datetime": "2014-12-31T23:59:59.938Z",
      "location_id": 1234567891234567,
      "booking_status_id": 1234567891234567,
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "membership_id": 1234567891234567,
      "cancelled": {
        "cancelled_by_id": 1234567891234567,
        "cancelled_on_datetime": "2014-12-31T23:59:59.938Z"
      }
    }
  ]
}