Change a block

PATCH

api

plan

{id}

Change a block

curl --request PATCH \
  --url https://client-api.lala.ist/api/plan/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "durationMin": 362,
  "subject": "<string>",
  "topic": "<string>",
  "activity": "<string>",
  "targetQuestions": 1000,
  "notes": "<string>",
  "position": 500,
  "doneQuestions": 1000
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '<string>',
    startTime: '<string>',
    endTime: '<string>',
    durationMin: 362,
    subject: '<string>',
    topic: '<string>',
    activity: '<string>',
    targetQuestions: 1000,
    notes: '<string>',
    position: 500,
    doneQuestions: 1000
  })
};

fetch('https://client-api.lala.ist/api/plan/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://client-api.lala.ist/api/plan/{id}"

payload = {
    "date": "<string>",
    "startTime": "<string>",
    "endTime": "<string>",
    "durationMin": 362,
    "subject": "<string>",
    "topic": "<string>",
    "activity": "<string>",
    "targetQuestions": 1000,
    "notes": "<string>",
    "position": 500,
    "doneQuestions": 1000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "blocks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "<string>",
      "startTime": "<string>",
      "endTime": "<string>",
      "durationMin": 0,
      "scheduled": true,
      "subject": "<string>",
      "topic": "<string>",
      "activity": "questions",
      "targetQuestions": 0,
      "notes": "<string>",
      "status": "planned",
      "doneQuestions": 0,
      "completedAt": "2023-11-07T05:31:56Z",
      "createdBy": "student",
      "position": 0,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "conflicts": [
    {
      "blockId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conflictsWith": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Supabase access token: Authorization: Bearer <token>

Path Parameters

string

required

Body

application/json

Partial update. Only the fields present are written. startTime: null takes the time off the block and keeps its length. completedAt follows status and is not accepted.

date

string

Local Istanbul calendar date, YYYY-MM-DD. Moves the block.

startTime

string | null

Local Istanbul wall clock, HH:MM. Leave it out for a block with no time yet.

endTime

string | null

Optional, and it needs a startTime. It sets the length, and it wins over durationMin. An end before the start is a block that runs past midnight.

durationMin

integer | null

The length in minutes. Valid on its own: "45 minutes, time undecided".

Required range: 5 <= x <= 720

subject

string

Required string length: 1 - 64

topic

string | null

Maximum string length: 200

activity

string

Maximum string length: 40

targetQuestions

integer | null

Required range: 1 <= x <= 2000

notes

string | null

Maximum string length: 1000

position

integer

Required range: 0 <= x <= 1000

status

enum<string>

Available options:

planned,

done,

skipped

doneQuestions

integer | null

Required range: 0 <= x <= 2000

Response

The block after the change, and any overlaps

blocks

object[]

required

Show child attributes

conflicts

object[]

required

Show child attributes

Change a block

curl --request PATCH \
  --url https://client-api.lala.ist/api/plan/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "durationMin": 362,
  "subject": "<string>",
  "topic": "<string>",
  "activity": "<string>",
  "targetQuestions": 1000,
  "notes": "<string>",
  "position": 500,
  "doneQuestions": 1000
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '<string>',
    startTime: '<string>',
    endTime: '<string>',
    durationMin: 362,
    subject: '<string>',
    topic: '<string>',
    activity: '<string>',
    targetQuestions: 1000,
    notes: '<string>',
    position: 500,
    doneQuestions: 1000
  })
};

fetch('https://client-api.lala.ist/api/plan/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://client-api.lala.ist/api/plan/{id}"

payload = {
    "date": "<string>",
    "startTime": "<string>",
    "endTime": "<string>",
    "durationMin": 362,
    "subject": "<string>",
    "topic": "<string>",
    "activity": "<string>",
    "targetQuestions": 1000,
    "notes": "<string>",
    "position": 500,
    "doneQuestions": 1000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "blocks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "<string>",
      "startTime": "<string>",
      "endTime": "<string>",
      "durationMin": 0,
      "scheduled": true,
      "subject": "<string>",
      "topic": "<string>",
      "activity": "questions",
      "targetQuestions": 0,
      "notes": "<string>",
      "status": "planned",
      "doneQuestions": 0,
      "completedAt": "2023-11-07T05:31:56Z",
      "createdBy": "student",
      "position": 0,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "conflicts": [
    {
      "blockId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conflictsWith": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

Overview

Endpoints

Authorizations

Path Parameters

Body

Response