Blog
Blog List
Use this API to list all blogs created in the LMS.
GET /blog/blog-list
Query string parameters
Field | Type | Description |
---|---|---|
firstRecord required | integer | First record to return. Default: 1 |
count required | integer | Number of records to be returned from the first record Default: 20, Max count limit: 100 |
q | string | filter data by blog title and description |
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"blogList": [
{
"blogId": 6,
"title": "Training & Upskilling for Professional Growth",
"description": "Training and upskilling are crucial for personal and professional growth. In today’s fast-paced world, staying competitive and relevant in the job market requires a continuous effort to acquire new skills and knowledge. The good news is that there are many ways to achieve this, and it doesn’t have to be time-consuming or expensive.",
"thumbnail": "https://wwww.example.com/thumbnail.png",
"status": true
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
Field | Type | Description |
---|---|---|
blogList | array | Array of blog objects. |
blogId | number | ID of the blog. |
title | string | Title of the blog. |
description | string | Description of the blog. |
thumbnail | string | URL to the blog's thumbnail image. |
status | boolean | Indicates the status of the blog. |
totalRecords | number | Total number of records in the response. |
Code | Description |
---|---|
1003 | "Invalid firstRecord" |
1004 | "Invalid count" |
For general error details, click here.
Blog Details
Use this API to list a get individual blog details.
GET /blog/{blogId}/detail
Path parameters
Field | Type | Description |
---|---|---|
blogId required | integer | A single blog ID |
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"blogDetail": {
"blogId": 6,
"title": "Training & Upskilling for Professional Growth",
"description": "Training and upskilling are crucial for personal and professional growth. In today’s fast-paced world, staying competitive and relevant in the job market requires a continuous effort to acquire new skills and knowledge. The good news is that there are many ways to achieve this, and it doesn’t have to be time-consuming or expensive.",
"thumbnail": "https://wwww.example.com/thumbnail.png",
"status": true
}
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
Field | Type | Description |
---|---|---|
blogDetail | object | Details about the blog. |
blogId | number | ID of the blog. |
title | string | Title of the blog. |
description | string | Description of the blog. |
thumbnail | string | URL to the blog's thumbnail image. |
status | boolean | Indicates the status of the blog. |
Code | Description |
---|---|
1002 | "Invalid blogId" |
1003 | "Missing blogId" |
For general error details, click here.