Community articleNew invitations GET9.0.1
Added by api wiki on October 25, 2013
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Gets the list of new invitations for a calendar on a Domino server.
Input
Method URI Description
GET /{database}/api/calendar/invitations Gets the list of new invitations for a calendar on a Domino server.
Name Type Optional Description
database
string No Path name of a database on the server relative to the data directory.
Name Type Optional Description
since
date Yes Returns only the invitations for events with a start date greater than the given date.
receivedsince
date Yes Returns only the invitations received since the given date.
id
string Yes Returns only the invitations associated with the given event ID.
Output
Content Type: application/json
Use the table below that represents the returned fields:
Name Type Optional Description
summary
string No Summary of the related event.
scheduleMethod
enumerated No Notice type.
Authorized values:
  • request
href
string No URL of the invitation.
Name Type Optional Description
Content-Type
string No Always is application/json.
Code Description
200
OK. Indicates that the request was handled successfully.
Examples
Get the list of new invitations for events with a start date greater than 2013-06-21T07:00:00 UTC
GET /mail/sdayrn.nsf/api/calendar/invitations?since=2013-06-21T07:00:00Z

Response returned by the server
{
    "notices": [
        {
            "summary": "Meeting 1",
            "scheduleMethod": "request",
            "href": "/mail/sdayrn.nsf/api/calendar/notices/CDD9D3F6695A0BADA855D48FBD905AA5"
        },
        {
            "summary": "Appointment 1",
            "scheduleMethod": "request",
            "href": "/mail/sdayrn.nsf/api/calendar/notices/E40F6AAA8BA3A99BA13121C88418BD2A"
        },
        {
            "summary": "Meeting 2",
            "scheduleMethod": "request",
            "href": "/mail/sdayrn.nsf/api/calendar/notices/AFDF517C0170E86D00257BB100220F7C"
        }
    ]
}
Gets the invitations associated with a specific event. The event is specified by the id query parameter.
GET /mail/sdayrn.nsf/api/calendar/invitations?id=AFDF517C0170E86D00257BB100220F7C-Lotus_Notes_Generated

Response returned by the server
{
    "notices": [
        {
            "summary": "Meeting 1",
            "scheduleMethod": "request",
            "href": "/mail/testerb.nsf/api/calendar/notices/AFDF517C0170E86D00257BB100220F7C"
        }
    ]
}