Brein API

Session Day

Get all session days with pagination

GET

/api/v1/session-day

Retrieve a paginated list of session days based on query parameters

Get all session days with pagination › query Parameters

sessionIdnumber · min: 1 · required
Session id
pagenumber
Current page
pageSizenumber
Page size

Get all session days with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/session-day

curl --request GET \
  --url '/api/v1/session-day?sessionId=1'

shell

Show example in

Example Responses

No example

json

application/json

Create a new session day

POST

/api/v1/session-day

Create a new session day with the provided data

Create a new session day › Request Body

datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
reasonstring · required
Reason for deletion
slotsobject[] · required
Time slots
sessionIdnumber · min: 1 · required
Session id
Example: 1

Create a new session day › Responses

Session Day created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
slotsobject[] · required
Time slots for the day
reasonstring · required
Reason for deletion

POST /api/v1/session-day

curl --request POST \
  --url /api/v1/session-day \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "reason": "reason",
  "slots": [
    {
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true,
      "id": 0
    }
  ],
  "sessionId": 1
}
'

shell

Show example in

Request Body Example

{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "reason": "reason",
  "slots": [
    {
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true,
      "id": 0
    }
  ],
  "sessionId": 1
}

json

Example Responses

No example

json

application/json

Get session day by ID

GET

/api/v1/session-day/{id}

Retrieve a specific session day by its ID

Get session day by ID › path Parameters

idnumber · min: 1 · required
Id

Get session day by ID › Responses

Session Day detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
slotsobject[] · required
Time slots for the day
reasonstring · required
Reason for deletion

GET /api/v1/session-day/{id}

curl --request GET \
  --url /api/v1/session-day/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a session day

PUT

/api/v1/session-day/{id}

Update an existing session day by its ID

Update a session day › path Parameters

idnumber · min: 1 · required
Id

Update a session day › Request Body

datestring · date-time
Session date
eventTypestring · enum
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring
Session location
meetingLinkstring
Session meeting link
slotsobject[]
Time slots for the day
reasonstring
Reason for deletion

Update a session day › Responses

Session Day updated

No data returned

PUT /api/v1/session-day/{id}

curl --request PUT \
  --url /api/v1/session-day/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "slots": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true
    }
  ],
  "reason": "reason"
}
'

shell

Show example in

Request Body Example

{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "slots": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true
    }
  ],
  "reason": "reason"
}

json

Example Responses

No example

plain

Delete a session day

DELETE

/api/v1/session-day/{id}

Delete a session day by its ID

Delete a session day › path Parameters

idnumber · min: 1 · required
Id

Delete a session day › Responses

Session Day deleted

No data returned

DELETE /api/v1/session-day/{id}

curl --request DELETE \
  --url /api/v1/session-day/:id

shell

Show example in

Example Responses

No example

plain

Pending Reminder Time Slot

Brein API

Session Day

Get all session days with pagination

GET

/api/v1/session-day

Retrieve a paginated list of session days based on query parameters

Get all session days with pagination › query Parameters

sessionIdnumber · min: 1 · required
Session id
pagenumber
Current page
pageSizenumber
Page size

Get all session days with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/session-day

curl --request GET \
  --url '/api/v1/session-day?sessionId=1'

shell

Show example in

Example Responses

No example

json

application/json

Create a new session day

POST

/api/v1/session-day

Create a new session day with the provided data

Create a new session day › Request Body

datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
reasonstring · required
Reason for deletion
slotsobject[] · required
Time slots
sessionIdnumber · min: 1 · required
Session id
Example: 1

Create a new session day › Responses

Session Day created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
slotsobject[] · required
Time slots for the day
reasonstring · required
Reason for deletion

POST /api/v1/session-day

curl --request POST \
  --url /api/v1/session-day \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "reason": "reason",
  "slots": [
    {
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true,
      "id": 0
    }
  ],
  "sessionId": 1
}
'

shell

Show example in

Request Body Example

{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "reason": "reason",
  "slots": [
    {
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true,
      "id": 0
    }
  ],
  "sessionId": 1
}

json

Example Responses

No example

json

application/json

Get session day by ID

GET

/api/v1/session-day/{id}

Retrieve a specific session day by its ID

Get session day by ID › path Parameters

idnumber · min: 1 · required
Id

Get session day by ID › Responses

Session Day detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
slotsobject[] · required
Time slots for the day
reasonstring · required
Reason for deletion

GET /api/v1/session-day/{id}

curl --request GET \
  --url /api/v1/session-day/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a session day

PUT

/api/v1/session-day/{id}

Update an existing session day by its ID

Update a session day › path Parameters

idnumber · min: 1 · required
Id

Update a session day › Request Body

datestring · date-time
Session date
eventTypestring · enum
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring
Session location
meetingLinkstring
Session meeting link
slotsobject[]
Time slots for the day
reasonstring
Reason for deletion

Update a session day › Responses

Session Day updated

No data returned

PUT /api/v1/session-day/{id}

curl --request PUT \
  --url /api/v1/session-day/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "slots": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true
    }
  ],
  "reason": "reason"
}
'

shell

Show example in

Request Body Example

{
  "date": "2024-08-25T15:00:00Z",
  "eventType": "ON_SITE",
  "location": "location",
  "meetingLink": "meetingLink",
  "slots": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "available": true
    }
  ],
  "reason": "reason"
}

json

Example Responses

No example

plain

Delete a session day

DELETE

/api/v1/session-day/{id}

Delete a session day by its ID

Delete a session day › path Parameters

idnumber · min: 1 · required
Id

Delete a session day › Responses

Session Day deleted

No data returned

DELETE /api/v1/session-day/{id}

curl --request DELETE \
  --url /api/v1/session-day/:id

shell

Show example in

Example Responses

No example

plain

Pending Reminder Time Slot