Message - OgnianApostolov/builderly-api-docs GitHub Wiki
Model
Message message {
"_id": {
"autogenerated": "true"
},
"sender_id": {
"ref": "User._ObjectId",
"required": "true"
},
"receiver_id": {
"ref": "User._ObjectId",
"required": "true"
},
"product_id": {
"ref": "Product._ObjectId",
"required": "true"
},
"message": [
{
"from": {
"ref": "User._ObjectId",
"required": "true"
},
"text": {
"type": "string",
"required": "true"
},
"createdAt": {
"type": "string"
}
}
],
"createdAt": {
"autogenerated": "true"
},
"updatedAt": {
"autogenerated": "true"
}
}
Methods
Create new
POST /messages
req.body required
method: 'POST'
{
url: 'https://{{your-builderly-domain}}/messages',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: message
}
Responses
Success - status 201
{}
Error - status 400
{
error_message
}
Retrieve multiple
GET /messages
method: 'GET'
{
url: 'https://{{your-builderly-domain}}/messages',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
[ messages ]
Error - status 400
{
error_message
}
- Example usages:
/messages
- Get all messages
Retrieve single
GET /messages/:id
method: 'GET'
{
url: 'https://{{your-builderly-domain}}/messages/{{message._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{
message
}
Not found - status 404
{}
Error - status 500
{
error_message
}
- Example usages:
/messages/:id
- Retrives a specific message
Update single
PATCH /messages/:id
method: 'PATCH'
{
url: 'https://{{your-builderly-domain}}/messages/{{message._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: message
}
Responses
Success - status 200
{ message }
Error - status 400
{
error_message
}
Not found - status 404
{}
Delete single
DELETE /messages/:id
method: 'DELETE'
{
url: 'https://{{your-builderly-domain}}/messages/{{message._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{ message }
Not found - status 404
{}
Error - status 500
{
error_message
}