Skip to end of metadata
Go to start of metadata

Announcement

An announcement is a message that does not directly map to a single appointment. This could urge people to do certain things or indicate a global change in the schedule like changed start and end times for lessons. Make sure to always include the user=~me parameter if you intend to get only the announcements meant for the current user.

If you want to specify an interval from which to return the announcements you can use the start and end parameters. You specify those as Unix timestamps and only appointments which start between those two instants will be returned. For an example see below.

Fields

Field

Type

Description

id

long

The id of this announcement. Do not store this value as it could change.

start

long

UTC Unix time from which on the announcement should be shown

end

long

UTC Unix time until which the announcement should be shown

title

string

The (descriptive) title of the announcement

text

string

More detailed information about the announcement

Query parameters

Parameter

Type

Description

current

boolean

Only retrieve the announcements that should be shown to users. This means the current time is within the start and end interval.

Example

$ curl "https://xxxxxx.zportal.nl/api/v2/announcements?user=~me&current=true&access_token=xxxxxxxxxxxxxxxxxxx"
{
  "response": {
    "status":200,
    "message":"",
    "startRow":0,
    "endRow":10,
    "totalRows":10,
    "data":[
      {
        "id":5,
        "start":42364236,
        "end":436234523,
        "title": "Don't forget to hand in your books!",
        "text": "All books need to be handed in on Friday 15-7, the time and place are indicated on your schedule."
      },
      ...
    ]
  }
}

  • No labels