Brein API

Lost Article

Get all lost articles with filters

GET

/api/v1/lost-article

Retrieve a paginated list of lost articles based on query parameters

Get all lost articles with filters › query Parameters

categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS
pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key

Get all lost articles with filters › 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/lost-article

curl --request GET \
  --url '/api/v1/lost-article?category=%3Cstring%3E'

shell

Show example in

Example Responses

No example

json

application/json

Create a new lost article

POST

/api/v1/lost-article

Create a new lost article report with the provided data

Create a new lost article › Request Body

namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
claimedByobject · required
Parent who claimed lost article
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

Create a new lost article › Responses

Lost Article created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
createdByAdministrativeobject · required
Administrative who reported lost article
createdBySchoolAdministratorobject · required
School administrator who reported lost article
createdByTeacherobject · required
Teacher who reported lost article
claimedByobject · required
Parent who claimed lost article
deliveredAtstring · date-time · required
Delivered at
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

POST /api/v1/lost-article

curl --request POST \
  --url /api/v1/lost-article \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "place": "place",
  "description": "description",
  "imgSlugs": [
    "string"
  ],
  "claimedBy": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "relationShip": "Mother",
    "name": "Jane",
    "genre": "FEMALE",
    "phone": "phone",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "status": "PENDING",
  "category": "ELECTRONICS"
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "place": "place",
  "description": "description",
  "imgSlugs": [
    "string"
  ],
  "claimedBy": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "relationShip": "Mother",
    "name": "Jane",
    "genre": "FEMALE",
    "phone": "phone",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "status": "PENDING",
  "category": "ELECTRONICS"
}

json

Example Responses

No example

json

application/json

Get all lost article categories

GET

/api/v1/lost-article/categories

Retrieve a list of all available lost article categories

Get all lost article categories › Responses

string

GET /api/v1/lost-article/categories

curl --request GET \
  --url /api/v1/lost-article/categories

shell

Show example in

Example Responses

No example

json

application/json

Get all lost article statuses

GET

/api/v1/lost-article/status

Retrieve a list of all available lost article statuses

Get all lost article statuses › Responses

string

GET /api/v1/lost-article/status

curl --request GET \
  --url /api/v1/lost-article/status

shell

Show example in

Example Responses

No example

json

application/json

Get lost articles claimed by current user

GET

/api/v1/lost-article/me

Retrieve all lost articles that have been claimed by the currently authenticated user

Get lost articles claimed by current user › Responses

Lost Article detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
createdByAdministrativeobject · required
Administrative who reported lost article
createdBySchoolAdministratorobject · required
School administrator who reported lost article
createdByTeacherobject · required
Teacher who reported lost article
claimedByobject · required
Parent who claimed lost article
deliveredAtstring · date-time · required
Delivered at
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

GET /api/v1/lost-article/me

curl --request GET \
  --url /api/v1/lost-article/me

shell

Show example in

Example Responses

No example

json

application/json

Get lost article by ID

GET

/api/v1/lost-article/{id}

Retrieve a specific lost article by its ID

Get lost article by ID › path Parameters

idnumber · min: 1 · required
Id

Get lost article by ID › Responses

Lost Article detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
createdByAdministrativeobject · required
Administrative who reported lost article
createdBySchoolAdministratorobject · required
School administrator who reported lost article
createdByTeacherobject · required
Teacher who reported lost article
claimedByobject · required
Parent who claimed lost article
deliveredAtstring · date-time · required
Delivered at
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

GET /api/v1/lost-article/{id}

curl --request GET \
  --url /api/v1/lost-article/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a lost article

PUT

/api/v1/lost-article/{id}

Update an existing lost article by its ID

Update a lost article › path Parameters

idnumber · min: 1 · required
Id

Update a lost article › Request Body

namestring
Name of article
placestring
Place
descriptionstring
Description article
imgSlugsstring[]
Image slugs
createdByAdministrativeobject
Administrative who reported lost article
createdBySchoolAdministratorobject
School administrator who reported lost article
createdByTeacherobject
Teacher who reported lost article
claimedByobject
Parent who claimed lost article
deliveredAtstring · date-time
Delivered at
statusstring · enum
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

Update a lost article › Responses

Lost Article updated

No data returned

PUT /api/v1/lost-article/{id}

curl --request PUT \
  --url /api/v1/lost-article/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "place": "place",
  "description": "description",
  "imgSlugs": [
    "string"
  ],
  "createdByAdministrative": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "levels": [
      "string"
    ],
    "lastName": "Doe",
    "firstName": "Jane",
    "secondLastName": "Smith",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "createdBySchoolAdministrator": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane"
  },
  "createdByTeacher": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "grades": [
      "string"
    ],
    "level": "Primary",
    "lastName": "Doe",
    "firstName": "Jane",
    "secondLastName": "Smith",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "claimedBy": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "relationShip": "Mother",
    "name": "Jane",
    "genre": "FEMALE",
    "phone": "phone",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "deliveredAt": "2024-08-25T15:00:00Z",
  "status": "PENDING",
  "category": "ELECTRONICS"
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "place": "place",
  "description": "description",
  "imgSlugs": [
    "string"
  ],
  "createdByAdministrative": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "levels": [
      "string"
    ],
    "lastName": "Doe",
    "firstName": "Jane",
    "secondLastName": "Smith",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "createdBySchoolAdministrator": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane"
  },
  "createdByTeacher": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "grades": [
      "string"
    ],
    "level": "Primary",
    "lastName": "Doe",
    "firstName": "Jane",
    "secondLastName": "Smith",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "claimedBy": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "lastName": "Doe",
    "secondLastName": "Smith",
    "relationShip": "Mother",
    "name": "Jane",
    "genre": "FEMALE",
    "phone": "phone",
    "birthDate": "2024-08-25T15:00:00Z"
  },
  "deliveredAt": "2024-08-25T15:00:00Z",
  "status": "PENDING",
  "category": "ELECTRONICS"
}

json

Example Responses

No example

plain

Delete a lost article

DELETE

/api/v1/lost-article/{id}

Delete a lost article by its ID

Delete a lost article › path Parameters

idnumber · min: 1 · required
Id

Delete a lost article › Responses

Lost Article deleted

No data returned

DELETE /api/v1/lost-article/{id}

curl --request DELETE \
  --url /api/v1/lost-article/:id

shell

Show example in

Example Responses

No example

plain

Claim a lost article

PATCH

/api/v1/lost-article/{id}/claim

Claim a lost article as belonging to the current user

Claim a lost article › path Parameters

idnumber · min: 1 · required
Id

Claim a lost article › Responses

Lost article claimed

No data returned

PATCH /api/v1/lost-article/{id}/claim

curl --request PATCH \
  --url /api/v1/lost-article/:id/claim

shell

Show example in

Example Responses

No example

plain

Mark lost article as delivered

PATCH

/api/v1/lost-article/{id}/delivered

Mark a lost article as delivered to its owner

Mark lost article as delivered › path Parameters

idnumber · min: 1 · required
Id

Mark lost article as delivered › Responses

Lost article delivered

No data returned

PATCH /api/v1/lost-article/{id}/delivered

curl --request PATCH \
  --url /api/v1/lost-article/:id/delivered

shell

Show example in

Example Responses

No example

plain

Cancel claim on lost article

PATCH

/api/v1/lost-article/{id}/claim/cancel

Cancel a previous claim on a lost article

Cancel claim on lost article › path Parameters

idnumber · min: 1 · required
Id

Cancel claim on lost article › Responses

The claim was cancelled

No data returned

PATCH /api/v1/lost-article/{id}/claim/cancel

curl --request PATCH \
  --url /api/v1/lost-article/:id/claim/cancel

shell

Show example in

Example Responses

No example

plain

Mark lost article as donated

PATCH

/api/v1/lost-article/{id}/donate

Mark a lost article as donated

Mark lost article as donated › path Parameters

idnumber · min: 1 · required
Id

Mark lost article as donated › Responses

Lost article donated

No data returned

PATCH /api/v1/lost-article/{id}/donate

curl --request PATCH \
  --url /api/v1/lost-article/:id/donate

shell

Show example in

Example Responses

No example

plain

Send reminder for lost article

PATCH

/api/v1/lost-article/{id}/reminder

Send a reminder notification for a specific lost article

Send reminder for lost article › path Parameters

idnumber · min: 1 · required
Id

Send reminder for lost article › Responses

Lost article reminder sent

No data returned

PATCH /api/v1/lost-article/{id}/reminder

curl --request PATCH \
  --url /api/v1/lost-article/:id/reminder

shell

Show example in

Example Responses

No example

plain

CronHistory Lost Article Reminder