Sign in
Therapists

Update therapist

Changed on

Update a specific field within a therapist object in the database

patch/therapists/{id}

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/therapists/{id}
  • Auth: none declared

Path parameters

idstring uuid required

Therapist ID

Request body

first_namestring

First name of the therapist

last_namestring

Last name of the therapist

schoolsinteger[]

List of school IDs associated with the therapist

district_idinteger

School district ID the therapist belongs to

emailstring email

Email of the therapist

activeboolean

Whether the therapist is active

Example request

{
  "first_name": "Kevin",
  "last_name": "Matilda",
  "schools": [
    1,
    2
  ],
  "district_id": 2,
  "email": "email123@example.com",
  "active": true
}

Response

Therapist updated successfully

idstring uuid required

Unique identifier for the therapist

first_namestring required
last_namestring required
emailstring email required
schoolsinteger[]

List of school IDs associated with the therapist

district_idinteger

School district ID the therapist belongs to

school_namesstring[]

List of school names associated with the therapist

district_namestring

Name of the school district the therapist belongs to

activeboolean required

Whether the therapist is currently active

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "first_name": "Kevin",
  "last_name": "Matilda",
  "email": "email123@example.com",
  "schools": [
    1,
    2
  ],
  "district_id": 2,
  "school_names": [
    "Generate High",
    "Sherman Center for Academic Excellence"
  ],
  "district_name": "Generate Public Schools",
  "active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:35:00Z"
}

Changes

  • e8df156eaed6Revision changes
    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

  • bd99a992b54aRevision changes
    • ▲

      the request property format changed from no format to email

    • ▲

      the response's body type changed from string to object for status

    • ●

      removed the request property

    • ●

      removed the request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the non-success response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status