AnnouncementApi.md

\AnnouncementApi

All URIs are relative to https://localhost/api/v1

Method	HTTP request	Description
AnnouncementGet	Get /announcement	Get site announcements.
AnnouncementGetUrgent	Get /announcement/urgent	Get urgent (banner) announcements.

AnnouncementGet

[]Announcement AnnouncementGet(ctx, optional) Get site announcements.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*AnnouncementGetOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AnnouncementGetOpts struct

Name	Type	Description	Notes
columns	optional.String	Array of column names to fetch. If omitted, will return all columns.

Return type

[]Announcement

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AnnouncementGetUrgent

[]Announcement AnnouncementGetUrgent(ctx, ) Get urgent (banner) announcements.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Announcement

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]