v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB
PSP Announcements

Get an announcement by ID

Retrieve a single announcement for a Public Status Page

get/psps/{pspId}/announcements/{id}

Path parameters

pspIdnumber required

ID of the Public Status Page

idnumber required

ID of the announcement

Response

The announcement

idinteger required
pspIdinteger nullable required
userIdinteger nullable required
titlestring nullable required
contentstring nullable required
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:status","oasType":"schema","type":"unknown","description":"Status of the announcement. Possible values: Offline (draft, not visible on status page), Pending (scheduled for publication), Published (currently visible on status page), Archived (historical record, no longer visible)","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:type","oasType":"schema","type":"unknown","description":"Type of the announcement. Possible values: Info (general information), Maintenance (scheduled maintenance notification), Issue (incident or issue notification)","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:deliveryStatus","oasType":"schema","type":"unknown","description":"Delivery status of the announcement to subscribers. Possible values: CantSend (cannot be sent to subscribers), InQueue (queued for delivery), Sent (successfully delivered)","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:startDate","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:endDate","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:creationDate","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:submitDate","oasType":"schema","type":"unknown","nullable":true}
sentCountinteger nullable required