Homepage Channel News API (1.0.0)

Download OpenAPI specification:Download

News published to the Homepage channel.
Production server URL: https://api.schedulr.ch
Development server URL: https://api.dev.schedulr.ch

List of news published to the homepage channel

Authorizations:

apiKeyAuth

query Parameters

offset	integer >= 0 Number of records to skip for pagination
limit	integer [ 0 .. 20 ] Maximum number of records to return (max 20)
sort	string Enum: "created_at" "-created_at" "updated_at" "-updated_at" "published_at" "-published_at" Sort by creation or publication dates. For example to sort by created_at ASC use "sort=created_at". For DESC it would be "sort=-created_at".
modified_since	string Example: modified_since=2022-02-01T21:11:25+00:00 Returns created and updated news since specified time (in ISO8601 format). Be careful - value must be URL-encoded (+ sign will convert into a space without encoding)

Responses

Response samples

200
401

Content type

application/json

{"total": 230,
"limit": 20,
"offset": 0,
"data": [{"id": 0,
"name": "string",
"author": "Jane Doe",
"news_date": "2023-08-23",
"news_datetime": "2023-08-01T06:56:11+00:00",
"ad_hoc": true,
"tags": [{"id": 23,
"name": "Announcement"
}
],
"translations": [{"language": "en",
"title": "Example Title",
"header": "Ut nec porttitor sem. Ut sed risus feugiat, vehicula ipsum eu, consectetur nibh. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"content": "In ut libero at nisl tristique viverra. Sed nibh mi, egestas sed volutpat blandit, interdum ac elit. Aenean blandit diam nunc, nec ornare urna aliquam ac. Phasellus sodales dui a scelerisque laoreet.",
"footer": "Nullam ultrices, erat et euismod varius, justo nibh finibus tellus, quis fringilla magna elit ac magna. Nulla vitae sem vestibulum, ultrices elit eu, ornare magna.",
"thumbnail": "https://example.com/example.jpg",
"created_at": "2023-08-01T06:56:11+00:00",
"updated_at": "2023-08-01T06:56:11+00:00",
"attachments": [{"name": "Example Document",
"url": "https://example.com/example.pdf"
}
],
"ad_hoc_text": "Ad hoc announcement"
}
],
"created_at": "2023-08-01T06:56:11+00:00",
"updated_at": "2023-08-01T06:56:11+00:00"
}
]
}

Single news item published the homepage channel

Authorizations:

apiKeyAuth

path Parameters

id

required

integer

News id

Responses

Response samples

200
401
404

Content type

application/json

{"data": {"id": 0,
"name": "string",
"author": "Jane Doe",
"news_date": "2023-08-23",
"news_datetime": "2023-08-01T06:56:11+00:00",
"ad_hoc": true,
"tags": [{"id": 23,
"name": "Announcement"
}
],
"translations": [{"language": "en",
"title": "Example Title",
"header": "Ut nec porttitor sem. Ut sed risus feugiat, vehicula ipsum eu, consectetur nibh. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"content": "In ut libero at nisl tristique viverra. Sed nibh mi, egestas sed volutpat blandit, interdum ac elit. Aenean blandit diam nunc, nec ornare urna aliquam ac. Phasellus sodales dui a scelerisque laoreet.",
"footer": "Nullam ultrices, erat et euismod varius, justo nibh finibus tellus, quis fringilla magna elit ac magna. Nulla vitae sem vestibulum, ultrices elit eu, ornare magna.",
"thumbnail": "https://example.com/example.jpg",
"created_at": "2023-08-01T06:56:11+00:00",
"updated_at": "2023-08-01T06:56:11+00:00",
"attachments": [{"name": "Example Document",
"url": "https://example.com/example.pdf"
}
],
"ad_hoc_text": "Ad hoc announcement"
}
],
"created_at": "2023-08-01T06:56:11+00:00",
"updated_at": "2023-08-01T06:56:11+00:00"
}
}