Brein API

Invitation Student Responses

Get all invitation student responses with filters

GET

/api/v1/invitation-student-response

Retrieve a list of invitation student responses based on query parameters

Get all invitation student responses with filters › query Parameters

invitationResponseIdnumber
Filter by invitation response ID
studentIdnumber
Filter by student ID
statusstring · enum
Filter by status
Enum values:
ACCEPTED
DECLINED

Get all invitation student responses with filters › Responses

List of invitation student responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response

curl --request GET \
  --url /api/v1/invitation-student-response

shell

Show example in

Example Responses

No example

json

application/json

Create a new invitation student response

POST

/api/v1/invitation-student-response

Create a new response from a student to an invitation

Create a new invitation student response › Request Body

invitationResponseIdnumber · required
Invitation response ID
Example: 1
studentIdnumber · required
Student ID
Example: 1
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

Create a new invitation student response › Responses

Invitation student response created successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

POST /api/v1/invitation-student-response

curl --request POST \
  --url /api/v1/invitation-student-response \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitationResponseId": 1,
  "studentId": 1,
  "status": "ACCEPTED"
}
'

shell

Show example in

Request Body Example

{
  "invitationResponseId": 1,
  "studentId": 1,
  "status": "ACCEPTED"
}

json

Example Responses

No example

json

application/json

Get invitation student response by ID

GET

/api/v1/invitation-student-response/{id}

Retrieve a specific invitation student response by its ID

Get invitation student response by ID › path Parameters

idnumber · min: 1 · required
Id

Get invitation student response by ID › Responses

Invitation student response found

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response/{id}

curl --request GET \
  --url /api/v1/invitation-student-response/:id

shell

Show example in

Example Responses

No example

json

application/json

Update invitation student response

PUT

/api/v1/invitation-student-response/{id}

Update an existing invitation student response by its ID

Update invitation student response › path Parameters

idnumber · min: 1 · required
Id

Update invitation student response › Request Body

statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

Update invitation student response › Responses

Invitation student response updated successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

PUT /api/v1/invitation-student-response/{id}

curl --request PUT \
  --url /api/v1/invitation-student-response/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACCEPTED"
}
'

shell

Show example in

Request Body Example

{
  "status": "ACCEPTED"
}

json

Example Responses

No example

json

application/json

Delete invitation student response

DELETE

/api/v1/invitation-student-response/{id}

Delete an invitation student response by its ID

Delete invitation student response › path Parameters

idnumber · min: 1 · required
Id

Delete invitation student response › Responses

Invitation student response deleted successfully

No data returned

DELETE /api/v1/invitation-student-response/{id}

curl --request DELETE \
  --url /api/v1/invitation-student-response/:id

shell

Show example in

Example Responses

No example

plain

Get all student responses for a specific invitation response

GET

/api/v1/invitation-student-response/invitation-response/{invitationResponseId}

Retrieve all student responses associated with a specific invitation response

Get all student responses for a specific invitation response › path Parameters

invitationResponseIdnumber · required

Get all student responses for a specific invitation response › Responses

List of student responses for the invitation response

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response/invitation-response/{invitationResponseId}

curl --request GET \
  --url /api/v1/invitation-student-response/invitation-response/:invitationResponseId

shell

Show example in

Example Responses

No example

json

application/json

ScheduleConfiguration Rules Transportation

Brein API

Invitation Student Responses

Get all invitation student responses with filters

GET

/api/v1/invitation-student-response

Retrieve a list of invitation student responses based on query parameters

Get all invitation student responses with filters › query Parameters

invitationResponseIdnumber
Filter by invitation response ID
studentIdnumber
Filter by student ID
statusstring · enum
Filter by status
Enum values:
ACCEPTED
DECLINED

Get all invitation student responses with filters › Responses

List of invitation student responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response

curl --request GET \
  --url /api/v1/invitation-student-response

shell

Show example in

Example Responses

No example

json

application/json

Create a new invitation student response

POST

/api/v1/invitation-student-response

Create a new response from a student to an invitation

Create a new invitation student response › Request Body

invitationResponseIdnumber · required
Invitation response ID
Example: 1
studentIdnumber · required
Student ID
Example: 1
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

Create a new invitation student response › Responses

Invitation student response created successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

POST /api/v1/invitation-student-response

curl --request POST \
  --url /api/v1/invitation-student-response \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitationResponseId": 1,
  "studentId": 1,
  "status": "ACCEPTED"
}
'

shell

Show example in

Request Body Example

{
  "invitationResponseId": 1,
  "studentId": 1,
  "status": "ACCEPTED"
}

json

Example Responses

No example

json

application/json

Get invitation student response by ID

GET

/api/v1/invitation-student-response/{id}

Retrieve a specific invitation student response by its ID

Get invitation student response by ID › path Parameters

idnumber · min: 1 · required
Id

Get invitation student response by ID › Responses

Invitation student response found

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response/{id}

curl --request GET \
  --url /api/v1/invitation-student-response/:id

shell

Show example in

Example Responses

No example

json

application/json

Update invitation student response

PUT

/api/v1/invitation-student-response/{id}

Update an existing invitation student response by its ID

Update invitation student response › path Parameters

idnumber · min: 1 · required
Id

Update invitation student response › Request Body

statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

Update invitation student response › Responses

Invitation student response updated successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

PUT /api/v1/invitation-student-response/{id}

curl --request PUT \
  --url /api/v1/invitation-student-response/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACCEPTED"
}
'

shell

Show example in

Request Body Example

{
  "status": "ACCEPTED"
}

json

Example Responses

No example

json

application/json

Delete invitation student response

DELETE

/api/v1/invitation-student-response/{id}

Delete an invitation student response by its ID

Delete invitation student response › path Parameters

idnumber · min: 1 · required
Id

Delete invitation student response › Responses

Invitation student response deleted successfully

No data returned

DELETE /api/v1/invitation-student-response/{id}

curl --request DELETE \
  --url /api/v1/invitation-student-response/:id

shell

Show example in

Example Responses

No example

plain

Get all student responses for a specific invitation response

GET

/api/v1/invitation-student-response/invitation-response/{invitationResponseId}

Retrieve all student responses associated with a specific invitation response

Get all student responses for a specific invitation response › path Parameters

invitationResponseIdnumber · required

Get all student responses for a specific invitation response › Responses

List of student responses for the invitation response

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

GET /api/v1/invitation-student-response/invitation-response/{invitationResponseId}

curl --request GET \
  --url /api/v1/invitation-student-response/invitation-response/:invitationResponseId

shell

Show example in

Example Responses

No example

json

application/json

ScheduleConfiguration Rules Transportation