Please see the full REST API documentation for API implementation details.

Resource: Meeting Series Source

A meeting series source identifies an event in another application from which a Lucid meeting series was created; for example, an event in a calendar application that integrates with Lucid Meetings. A one-to-one mapping is expected. The meeting seriessource can then be used to look up a Lucid meeting series based on the source event.

For example, the Lucid Meetings Chrome extension creates meeting series based on Google calendar events, using the string "google_event" for the source_type and using Google's event ID for the source_id property.

It is expected that applications will have use for only their own meeting series sources. If your application doesn't create meeting series sources, you can safely ignore them.


Properties

#
Field Type Notes
meeting_series_source_id integer
member_id integer Identifies the Lucid member who created the meeting source
source_type plain text (20) An identifier for the source application. Typically an application that creates meeting sources will use the same source_type for all of them.
source_id plain text (255) An identifier for the source event (typically). The combination of source_type and source_id must be unique.
meeting_series_id integer Identifies a meeting series
source_data string, number, array, object, or NULL Arbitrary data uploaded by the API user (application) for later reference.
create_ts timestamp
update_ts timestamp

Getting a List of My Meeting Sources

#
GET /lucid/api/v1/meeting_series_sources (must be logged in)
Query parameter Notes
source_type Restrict to meeting series sources with the specified source_type
source_id Restrict to meeting series sources with the specified source_id
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive.
Default: 10.
sort One of: create_ts , -create_ts
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/meeting_series_sources?source_type=test_source&fields=meeting_series_source_id,source_type,source_id,meeting_series_id,member_id
Content-Type: application/json; charset=utf-8
Content-Length: 386
X-Page-Num: 0
X-Per-Page: 10
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 96
X-Rate-Limit-Reset: 41
X-Rate-Limit-Used: 2
X-Requestor: afarrell@secondrise.com
X-Total-Count: 2
X-Total-Pages: 1
[
    {
        "meeting_series_source_id": 173,
        "source_type": "test_source",
        "source_id": "test_source_id_B",
        "meeting_series_id": 584,
        "member_id": 302
    },
    {
        "meeting_series_source_id": 172,
        "source_type": "test_source",
        "source_id": "test_source_id_A",
        "meeting_series_id": 587,
        "member_id": 302
    }
]

Getting the Meeting Series Source for a Meeting Series

#

The meeting series sources collection for a meeting series will contain zero or one items.

GET /lucid/api/v1/meeting_series/:meeting_series_id/meeting_series_sources

Sample Request

GET /lucid/api/v1/meeting_series/584/meeting_series_sources
Content-Type: application/json; charset=utf-8
Content-Length: 995
[
    {
        "id": 173,
        "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series_sources/173",
        "meeting_series_source_id": 173,
        "source_type": "testSource",
        "source_id": "testSourceId1234",
        "source_data": {
            "additional_info": {
                "a": 1,
                "b": 2
            }
        },
        "meeting_series_id": 584,
        "member_id": 302,
        "create_ts": {
            "value": 1572653328,
            "iso_8601": "2019-11-02T00:08:48Z",
            "pretty": {
                "time": "5:08 PM",
                "date": "November 1, 2019",
                "timezone": "Los Angeles"
            }
        },
        "update_ts": {
            "value": 1576020434,
            "iso_8601": "2019-12-10T23:27:14Z",
            "pretty": {
                "time": "3:27 PM",
                "date": "December 10, 2019",
                "timezone": "Los Angeles"
            }
        }
    }
]

Getting a Single Meeting Source

#
GET /lucid/api/v1/meeting_series_sources/:meeting_series_source_id
Query parameter Notes
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/meeting_series_sources/173
Content-Type: application/json; charset=utf-8
Content-Length: 753
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 99
X-Rate-Limit-Reset: 60
X-Rate-Limit-Used: 1
X-Requestor: afarrell@secondrise.com
{
    "id": 173,
    "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series_sources/173",
    "meeting_series_source_id": 173,
    "source_type": "test_source",
    "source_id": "test_source_id_B",
    "meeting_series_id": 584,
    "member_id": 302,
    "create_ts": {
        "value": 1572653328,
        "iso_8601": "2019-11-02T00:08:48Z",
        "pretty": {
            "time": "5:08 PM",
            "date": "November 1, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1572653328,
        "iso_8601": "2019-11-02T00:08:48Z",
        "pretty": {
            "time": "5:08 PM",
            "date": "November 1, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Creating a New Meeting Source

#
POST /lucid/api/v1/meeting_series/:meeting_series_id/meeting_series_sources
Field Required Notes
source_type yes
source_id yes

Sample Request

POST /lucid/api/v1/meeting_series/587/meeting_series_sources
Content-Type: application/json
{
  "source_type": "test_source",
  "source_id": "test_source_id_A"
}
201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meeting_series/587/meeting_series_sources/172
Content-Type: application/json
{
    "id": 172,
    "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series_sources/172",
    "meeting_series_source_id": 172,
    "source_type": "test_source",
    "source_id": "test_source_id_A",
    "meeting_series_id": 587,
    "member_id": 302,
    "create_ts": {
        "value": 1572652618,
        "iso_8601": "2019-11-01T23:56:58Z",
        "pretty": {
            "time": "4:56 PM",
            "date": "November 1, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1572652618,
        "iso_8601": "2019-11-01T23:56:58Z",
        "pretty": {
            "time": "4:56 PM",
            "date": "November 1, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Updating a Meeting Series Source via PATCH

#
PATCH /lucid/api/v1/meeting_sources/:meeting_source_id
Field Required Notes
source_type no
source_id no
source_data no

Sample Request

PATCH /lucid/api/v1/meeting_series_sources/694
Content-Type: application/json
{
    "source_id": "testSourceId_1235",
    "source_data": {
        "last_updated": 1575940855,
        "updated_by": "Jane Doe"
    }
}
200 OK
Content-Type: application/json
{
    "id": 173,
    "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series_sources/173",
    "meeting_series_source_id": 173,
    "source_type": "testSource",
    "source_id": "testSourceId_1235",
    "source_data": {
        "last_updated": 1575940855,
        "updated_by": "Jane Doe"
    },
    "meeting_series_id": 584,
    "member_id": 302,
    "create_ts": {
        "value": 1572653328,
        "iso_8601": "2019-11-02T00:08:48Z",
        "pretty": {
            "time": "5:08 PM",
            "date": "November 1, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1576020705,
        "iso_8601": "2019-12-10T23:31:45Z",
        "pretty": {
            "time": "3:31 PM",
            "date": "December 10, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Deleting a Meeting Source

#
DELETE /lucid/api/v1/meeting_series_sources/:meeting_series_source_id

Sample Request

DELETE /lucid/api/v1/meeting_series_sources/173
204 No Content