Brein API

Invitations

Get all invitations with filters

GET

/api/v1/invitation

Get all invitations with filters › query Parameters

pagenumber
Current page
pageSizenumber
Page size
createdByIdnumber
Filter by created by parent ID
hostIdnumber
Filter by host student ID
destinationIdnumber
Filter by destination trusted address ID
invitationTypestring · enum
Filter by invitation type
Enum values:
TRANSPORT_ROUTE
CAR
keystring
Search key for filtering invitations
levelsstring[]
Filter by student levels
fromDatestring · date-time
From date
toDatestring · date-time
To date
routeIdnumber
Route ID
statusstring
Status of invitation
sortobject
Sort options

Get all invitations with filters › Responses

Invitations retrieved successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests

Create a new invitation

POST

/api/v1/invitation

Create a new invitation › Request Body

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
destinationIdnumber · required
ID of the destination trusted address
hostIdnumber · required
ID of the host student
trustedPeopleIdnumber · required
ID of the trusted people

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests
responsibleParentIdnumber
ID of the responsible parent

Create a new invitation › Responses

Invitation created successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests

POST /api/v1/invitation

curl --request POST \
  --url /api/v1/invitation \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 0,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "rejectedBy": "PARENT",
  "date": "2024-08-25T15:00:00Z",
  "title": "title",
  "message": "message",
  "invitationType": "TRANSPORT_ROUTE",
  "destinationId": 0,
  "hostId": 0,
  "responsibleParentId": 0,
  "trustedPeopleId": 0
}
'

shell

Show example in

Request Body Example

{
  "id": 0,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "rejectedBy": "PARENT",
  "date": "2024-08-25T15:00:00Z",
  "title": "title",
  "message": "message",
  "invitationType": "TRANSPORT_ROUTE",
  "destinationId": 0,
  "hostId": 0,
  "responsibleParentId": 0,
  "trustedPeopleId": 0
}

json

Example Responses

No example

json

application/json

Get all invitations created by the user

GET

/api/v1/invitation/created

Get all invitations created by the user › Responses

Invitations retrieved successfully

invitationResponsesobject[] · required
Invitation responses created by the user
exitPermissionsobject[] · required
Exit permissions created by the user with additional details

GET /api/v1/invitation/created

curl --request GET \
  --url /api/v1/invitation/created

shell

Show example in

Example Responses

No example

json

application/json

Get all invitations received by the user

GET

/api/v1/invitation/received

Get all invitations received by the user › Responses

Invitations retrieved successfully

No data returned

GET /api/v1/invitation/received

curl --request GET \
  --url /api/v1/invitation/received

shell

Show example in

Example Responses

No example

plain

Download invitations as Excel file

GET

/api/v1/invitation/download

Generate and download an Excel file with invitations based on query parameters

Download invitations as Excel file › query Parameters

pagenumber
Current page
pageSizenumber
Page size
createdByIdnumber
Filter by created by parent ID
hostIdnumber
Filter by host student ID
destinationIdnumber
Filter by destination trusted address ID
invitationTypestring · enum
Filter by invitation type
Enum values:
TRANSPORT_ROUTE
CAR
keystring
Search key for filtering invitations
levelsstring[]
Filter by student levels
fromDatestring · date-time
From date
toDatestring · date-time
To date
routeIdnumber
Route ID
statusstring
Status of invitation
sortobject
Sort options

Download invitations as Excel file › Responses

File download URL generated successfully

fileNamestring
Name of the generated file
urlstring
Signed S3 URL to download the file
expiresInnumber
URL expiration time in seconds

GET /api/v1/invitation/download

curl --request GET \
  --url /api/v1/invitation/download

shell

Show example in

Example Responses

No example

json

application/json

Get invitation by ID

GET

/api/v1/invitation/{id}

Get invitation by ID › path Parameters

idnumber · min: 1 · required
Id

Get invitation by ID › Responses

Invitation retrieved successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests

GET /api/v1/invitation/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update invitation

PUT

/api/v1/invitation/{id}

Update invitation › path Parameters

idnumber · min: 1 · required
Id

Update invitation › Request Body

idnumber
Id
createdAtstring · date-time
Creation Date
updatedAtstring · date-time
Updated Date
rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
datestring · date-time
Date and time of the invitation event
titlestring · maxLength: 50
Title of the invitation
messagestring · maxLength: 250
Message for the guests
invitationTypestring · enum
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
destinationIdnumber
ID of the destination trusted address
hostIdnumber
ID of the host student
responsibleParentIdnumber
ID of the responsible parent
trustedPeopleIdnumber
ID of the trusted people

Update invitation › Responses

Invitation updated successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests

PUT /api/v1/invitation/{id}

curl --request PUT \
  --url /api/v1/invitation/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 0,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "rejectedBy": "PARENT",
  "date": "2024-08-25T15:00:00Z",
  "title": "title",
  "message": "message",
  "invitationType": "TRANSPORT_ROUTE",
  "destinationId": 0,
  "hostId": 0,
  "responsibleParentId": 0,
  "trustedPeopleId": 0
}
'

shell

Show example in

Request Body Example

{
  "id": 0,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "rejectedBy": "PARENT",
  "date": "2024-08-25T15:00:00Z",
  "title": "title",
  "message": "message",
  "invitationType": "TRANSPORT_ROUTE",
  "destinationId": 0,
  "hostId": 0,
  "responsibleParentId": 0,
  "trustedPeopleId": 0
}

json

Example Responses

No example

json

application/json

Delete invitation

DELETE

/api/v1/invitation/{id}

Delete invitation › path Parameters

idnumber · min: 1 · required
Id

Delete invitation › Responses

Invitation deleted successfully

No data returned

Update invitation response (accept/decline)

PUT

/api/v1/invitation/{id}/respond

Update the response of an invitation (accept/decline)

Update invitation response (accept/decline) › path Parameters

idnumber · min: 1 · required
Id

Update invitation response (accept/decline) › Request Body

statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
studentIdsnumber[] · required
Student list of Ids

Update invitation response (accept/decline) › Responses

Invitation response updated successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
parentobject · required
Parent who responded to the invitation
invitationobject · required
Invitation that was responded to
statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
respondedAtstring · date-time · required
When the parent responded
invitationStudentResponsesobject[] · required
Individual student responses for this invitation response

PUT /api/v1/invitation/{id}/respond

curl --request PUT \
  --url /api/v1/invitation/:id/respond \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING",
  "studentIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "status": "PENDING",
  "studentIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Respond to an invitation (accept/decline)

POST

/api/v1/invitation/{id}/respond

Respond to an invitation (accept/decline) › path Parameters

idnumber · min: 1 · required
Id

Respond to an invitation (accept/decline) › Request Body

statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
studentIdsnumber[] · required
Student list of Ids

Respond to an invitation (accept/decline) › Responses

Response recorded successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
parentobject · required
Parent who responded to the invitation
invitationobject · required
Invitation that was responded to
statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
respondedAtstring · date-time · required
When the parent responded
invitationStudentResponsesobject[] · required
Individual student responses for this invitation response

POST /api/v1/invitation/{id}/respond

curl --request POST \
  --url /api/v1/invitation/:id/respond \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING",
  "studentIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "status": "PENDING",
  "studentIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Get all responses for an invitation

GET

/api/v1/invitation/{id}/responses

Get all responses for an invitation › path Parameters

idnumber · min: 1 · required
Id

Get all responses for an invitation › Responses

Responses retrieved successfully

No data returned

GET /api/v1/invitation/{id}/responses

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

shell

Show example in

Example Responses

No example

plain

Update the status of an invitation

PATCH

/api/v1/invitation/{id}/status

Update the status of an invitation › path Parameters

idnumber · min: 1 · required
Id

Update the status of an invitation › Request Body

statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

Update the status of an invitation › Responses

Invitation status updated successfully

No data returned

PATCH /api/v1/invitation/{id}/status

curl --request PATCH \
  --url /api/v1/invitation/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING"
}
'

shell

Show example in

Request Body Example

{
  "status": "PENDING"
}

json

Example Responses

No example

plain

TrustedAddress RouteAvailability