Classes

This API documentation provides a comprehensive guide for interacting with the class management system in Whautomate. This allows you to interact using API and sync classes between multiple systems.

Here's a breakdown of the functionalities offered:

• Search or Retrieve Classes (GET /v1/classes): This method allows you to find specific classes or retrieve a full list. You can optionally filter the results based on various criteria (e.g., date range, location, instructor).

• Get Individual Class By Id (GET /v1/classes/{classId}): Use this method to retrieve detailed information about a particular class by providing its unique identifier.

• Create a New Class (POST /v1/classes): This method enables you to create new classes by specifying details like date, time, location, instructor, service (type of class), and any other relevant information.

• Update Class (PUT /v1/classes/{classId}): Modify details of an existing class using this method. You can update information like date, time, instructor, or other relevant attributes.

• Delete Class By Id (DELETE /v1/classes/{classId}): This method allows you to permanently remove a class from the schedule.

• Get Participants of a Class (GET /v1/classes/{classId}/participants): Retrieve a list of participants enrolled in a specific class by providing its unique identifier.

• Add Participant to Class (POST /v1/classes/{classId}/participants/add): This method allows you to enroll participants in a specific class.

• Remove Participant from Class (POST /v1/classes/{classId}/participants/cancel): Use this method to cancel a participant's enrollment from a specific class.

• Get Class bookings of a Client (GET /v1/classes/clients/{clientId}/bookings): Use this method to get all the classes booked by a particular client using their Id.

By leveraging this API, you can streamline your class management process, ensuring a clear and organized class schedule along with efficient participant management.

Search or retrieve Classes

GET<YOUR HOST>/v1/classes

Query parameters

Header parameters

Response

200

200 response

Body

application/json

id*string

location*object

staff*object

timezonestring

date*string (date)

time*string

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

bookedParticipantsinteger

numberOfParticipantsinteger

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "staff": {
      "id": "text",
      "name": "text"
    },
    "timezone": "text",
    "date": "2024-11-21",
    "time": "text",
    "startTimeUTC": "2024-11-21T06:26:03.847Z",
    "startTime": "2024-11-21T06:26:03.847Z",
    "endTimeUTC": "2024-11-21T06:26:03.847Z",
    "endTime": "2024-11-21T06:26:03.847Z",
    "service": {
      "id": "text",
      "name": "text",
      "sellingPrice": 0
    },
    "status": "text",
    "createdAt": "2024-11-21T06:26:03.847Z",
    "updatedAt": "2024-11-21T06:26:03.847Z"
  }
]

Get Individual Class By Id

GET<YOUR HOST>/v1/classes/{classId}

Path parameters

classId*string

Header parameters

Response

200

200 response

Body

application/json

id*string

location*object

staff*object

timezonestring

date*string (date)

time*string

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

bookedParticipantsinteger

numberOfParticipantsinteger

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2024-11-21",
  "time": "text",
  "startTimeUTC": "2024-11-21T06:26:03.847Z",
  "startTime": "2024-11-21T06:26:03.847Z",
  "endTimeUTC": "2024-11-21T06:26:03.847Z",
  "endTime": "2024-11-21T06:26:03.847Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "status": "text",
  "createdAt": "2024-11-21T06:26:03.847Z",
  "updatedAt": "2024-11-21T06:26:03.847Z"
}

Create a new Class

POST<YOUR HOST>/v1/classes

Header parameters

Body

application/json

location*object

staff*object

date*string

Date of the class in YYYY-MM-DD format

time*string

Time of the class

service*object

numberOfParticipantsinteger

Number of participants in the class (optional)

timezonestring

Timezone of the class (optional)

Response

200

200 response

Body

application/json

id*string

location*object

staff*object

timezonestring

date*string (date)

time*string

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

bookedParticipantsinteger

numberOfParticipantsinteger

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "date": "text",
      "location": {
        "id": "text"
      },
      "service": {
        "id": "text"
      },
      "staff": {
        "id": "text"
      },
      "time": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2024-11-21",
  "time": "text",
  "startTimeUTC": "2024-11-21T06:26:03.847Z",
  "startTime": "2024-11-21T06:26:03.847Z",
  "endTimeUTC": "2024-11-21T06:26:03.847Z",
  "endTime": "2024-11-21T06:26:03.847Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "status": "text",
  "createdAt": "2024-11-21T06:26:03.847Z",
  "updatedAt": "2024-11-21T06:26:03.847Z"
}

Update Class

PUT<YOUR HOST>/v1/classes/{classId}

Path parameters

classId*string

Header parameters

Body

application/json

location*object

staff*object

date*string

Date of the class in YYYY-MM-DD format

time*string

Time of the class

service*object

numberOfParticipantsinteger

Number of participants in the class (optional)

timezonestring

Timezone of the class (optional)

Response

200

200 response

Body

application/json

id*string

location*object

staff*object

timezonestring

date*string (date)

time*string

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

bookedParticipantsinteger

numberOfParticipantsinteger

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}', {
    method: 'PUT',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "date": "text",
      "location": {
        "id": "text"
      },
      "service": {
        "id": "text"
      },
      "staff": {
        "id": "text"
      },
      "time": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "timezone": "text",
  "date": "2024-11-21",
  "time": "text",
  "startTimeUTC": "2024-11-21T06:26:03.847Z",
  "startTime": "2024-11-21T06:26:03.847Z",
  "endTimeUTC": "2024-11-21T06:26:03.847Z",
  "endTime": "2024-11-21T06:26:03.847Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "status": "text",
  "createdAt": "2024-11-21T06:26:03.847Z",
  "updatedAt": "2024-11-21T06:26:03.847Z"
}

Delete Class By Id

DELETE<YOUR HOST>/v1/classes/{classId}

Path parameters

classId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}

Get Participants of a Class

GET<YOUR HOST>/v1/classes/{classId}/participants

Path parameters

classId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

clientobject

paymentStatusstring

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}/participants', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2024-11-21T06:26:03.847Z",
    "updatedAt": "2024-11-21T06:26:03.847Z"
  }
]

Add Participant to Class

POST<YOUR HOST>/v1/classes/{classId}/participants/add

Path parameters

classId*string

Header parameters

Body

application/json

client*object

statusenum

Client's booking status (optional)

BOOKEDWAITLISTED

Response

200

200 response

Body

application/json

idstring

clientobject

paymentStatusstring

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}/participants/add', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "client": {}
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2024-11-21T06:26:03.847Z",
  "updatedAt": "2024-11-21T06:26:03.847Z"
}

Remove Participant from Class

POST<YOUR HOST>/v1/classes/{classId}/participants/cancel

Path parameters

classId*string

Header parameters

Body

application/json

participantId*string

Unique identifier for the participant

cancellationReasonstring

Reason for cancellation provided by the participant (optional)

Response

200

200 response

Body

application/json

idstring

clientobject

paymentStatusstring

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/classes/{classId}/participants/cancel', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "participantId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2024-11-21T06:26:03.847Z",
  "updatedAt": "2024-11-21T06:26:03.847Z"
}

Get Class Bookings of Particular Client

GEThttps://<YOUR HOST>/v1/classes/clients/{clientId}/bookings

Authorization

api_key

Path parameters

clientId*string

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

clientobject

paymentStatusstring

statusstring

createdAtstring (date-time)

updatedAtstring (date-time)

classobject

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/classes/clients/{clientId}/bookings', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2024-11-21T06:26:03.847Z",
    "updatedAt": "2024-11-21T06:26:03.847Z",
    "class": {
      "id": "text",
      "location": {
        "id": "text",
        "title": "text"
      },
      "staff": {
        "id": "text",
        "name": "text"
      },
      "timezone": "text",
      "date": "2024-11-21",
      "time": "text",
      "startTimeUTC": "2024-11-21T06:26:03.847Z",
      "startTime": "2024-11-21T06:26:03.847Z",
      "endTimeUTC": "2024-11-21T06:26:03.847Z",
      "endTime": "2024-11-21T06:26:03.847Z",
      "service": {
        "id": "text",
        "name": "text",
        "sellingPrice": 0
      },
      "status": "text",
      "createdAt": "2024-11-21T06:26:03.847Z",
      "updatedAt": "2024-11-21T06:26:03.847Z"
    }
  }
]