Versions Compared

Old Version 12

changes.mady.by.user Former user

Saved on

compared with

New Version 13

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example response body: none (status code 204 indicates success/user not found)

/users/{username}/synchronizations

Method: GET

Description: Query all synchronizations for a user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronization should be created.-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations

Example response body

Code Block
languagenone
{
    "synchronizations": [
        {
            "id": 1, 
            "type": "ews", 
            "username": "alice"
        }
    ]
}

/users/{username}/synchronizations

Method: DELETE

Description: Delete all synchronizations for a user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronizations should be deleted.-
unlinkMode(required)

The unlink mode indicates what should happen to the events in the user's calendar:

  • UNLINK_ONLYLeaves all events in place.
  • DELETE_FUTURE_EVENTSOnly events which have been pushed with this specific synchronization id and which have a start date in the future are removed.
  • DELETE_ALL_EVENTSAll events which have been pushed with this specific synchronization id are removed.
  • CLEANUPAll events which have been pushed by this MyTimetable instance are removed, even those with a different synchronization id.
-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations?unlinkMode=DELETE_ALL_EVENTS

Example response body: none (status code 204 indicates success)

/users/{username}/synchronizations/{type}

Method: DELETE

Description: Delete synchronizations of a certain type for a certain user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronizations should be deleted.-
type(required)The synchronization type, which indicates the calendaring service provider.-
unlinkMode(required)

The unlink mode indicates what should happen to the events in the user's calendar:

  • UNLINK_ONLYLeaves all events in place.
  • DELETE_FUTURE_EVENTSOnly events which have been pushed with this specific synchronization id and which have a start date in the future are removed.
  • DELETE_ALL_EVENTSAll events which have been pushed with this specific synchronization id are removed.
  • CLEANUPAll events which have been pushed by this MyTimetable instance are removed, even those with a different synchronization id.
-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations/ews?unlinkMode=DELETE_ALL_EVENTS

Example response body: none (status code 204 indicates success; 422 indicates no synchronizations found)

Synchronization resources

...

Code Block
languagenone
{
    "synchronizations": [
        {
            "id": 1,
            "username": "alice",
            "type": "o365"
        },
        {
            "id": 2,
            "username": "bob",
            "type": "googlecalendar"
        }
    ]
}

/synchronizations

Method: PUT

Description: Sets up a synchronization with a user's external calendar.

...

Code Block
languagenone
username=alice&type=ews&provisioning_smtpAddress=alice@example.org

Example response body: none (status code 204 indicates success)

Code Block
languagenone
{
    "synchronization":
        {
            "id": 1,
            "username": "alice",
            "type": "ews"
        }
}


/synchronizations/{id}

Method: DELETE

...