Upbooks API

GetActiveAnnouncements

GET

https://api.upbooks.io/api/v1/announcement/active

Announcement

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

array[object (AnnouncementDocumentJSON) {12}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

image

string

required

title

string

required

summary

string

required

link

string

required

startDate

string <date-time>

required

endDate

string <date-time>

required

isActive

boolean

required

isDeleted

boolean

required

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "__v": 0,
            "_id": "string",
            "image": "string",
            "title": "string",
            "summary": "string",
            "link": "string",
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z",
            "isActive": true,
            "isDeleted": true
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success

Modified at 2024-04-15 10:16:47

AddAnnouncement

GetAnnouncementDetail