Blog
Blog List
Use this API to list all blogs.
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": "Test Title",
"description": "Test",
"thumbnail": "",
"status": true
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
Field | Type | Description |
---|---|---|
blogId | integer | Blog ID |
title | string | Blog Title |
description | string | Blog Description |
thumbnail | string | Blog Image |
status | boolean | Active/Inactive |
totalRecords | integer | Count of records returned |
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": "Test Title",
"description": "test",
"thumbnail": "../image.jpg",
"status": true
}
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
Field | Type | Description |
---|---|---|
blogId | integer | Blog ID |
title | string | Blog Title |
description | string | Blog Description |
thumbnail | string | Blog Image |
status | boolean | Active/Inactive |
Code | Description |
---|---|
1002 | "Invalid blogId" |
1003 | "Missing blogId" |
For general error details, click here.