Localist Event Calendar Software API

The Localist API is a simple HTTP-based interface. Standard HTTP calls will return JSON your application can use.

It stands to reason that Localist’s API is the most powerful calendar API in the world (muahahah!).

Your use and access to the API is expressly conditioned on your compliance with the policies, restrictions and other provisions related to the API set forth in our API Terms of Use and the other documentation we provide you. You must also comply with the restrictions set forth in the Localist Terms of Service and the Localist Privacy Policy, in all uses of the API. If Localist believes that you have or attempted to violate any term, condition or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.

The Localist API is currently read-only.

Usage

All the resources described are available under http://CALENDAR-URL/api/2/. A simple HTTP GET request can be made to retrieve results. Requests that change data require a HTTP POST or HTTP PUT. Requests that remove data require a HTTP DELETE.

Note: All examples need to have your calendars’s URL in place of the CALENDAR-URL placeholder. For instance, if your calendar is at http://calendar.example.edu, the API is located at http://calendar.example.edu/api/2/.

Important: http://CALENDAR-URL/api/2/ is the starting point of the API. It will not return anything on its own. The API needs to know what type of content to return, which is outlined in the Resources section.

Versioning

The API has a version number, currently 2.1. The minor version is incremented whenever we make changes to either the parameters or output that are incompatible or may require special attention.

When possible, new resources, parameters and response fields are made available to all versions.

You can request a specific version of the API parameters and responses by using the full version in the path, instead of “2”. For example, to access the original API 2 release, you can use a URL of http://CALENDAR-URL/api/2.0/.

Using http://CALENDAR-URL/api/2/ will give you the current version. When a new version of the API is launched, this endpoint will continue to serve the prior version for a short period of time, allowing time for clients to update.

The changes in each revision can be found in the recent changes section and are also documented with the associated resources.

Usage Limits

There are currently no publicly defined usage limits on the API. However, be considerate when using the API and limit the rate of your requests to less than 1 request/second. Please cache data when possible, especially for less-frequently updated resources. We reserve the right to block offending hosts and/or applications to preserve the performance and stability of Localist.

All requests should either be OAuth signed or include identifying information in the User Agent.

API Terms of Use

Certain terms which are capitalized herein and not otherwise defined, have the meaning set forth in the Localist Terms of Service.

Your subscription to the Service enables you to access and use the API, including to develop and implement web and software services, scripts and applications (“Localist Applications”) for use in connection with your subscription to the Service for your internal business purposes in accordance with the Localist Terms of Service. Localist also permits you to publish Localist Applications and make them available to third parties subject to you entering into and complying with the Localist Application Developer and API Agreement.

In order to use and access the API, you must be an active Localist Enterprise Licensee. Your agreement is the only means through which you are authorized to access the API.

Except as expressly permitted pursuant to a Localist Application Developer and API Agreement to which you are a party to, you may not use or access the API to obtain access to or extract any data stored or transmitted through the Service other than Your Content or to input data from any external source into the Service other than to your Account.

You may not use the API to substantially replicate products or services offered by Localist, including, without limitation, functions or clients on platforms (such as iOS or Android) where Localist offers its own client or function. Localist Applications may not use or access the API or the Service in order to monitor the availability, performance, or functionality of any of the API or Service or for any similar benchmarking purposes.

You may not, under any circumstances, through a Localist Application or otherwise, repackage or resell the Service or API. You are not permitted to use or access the API in any manner that does or could potentially undermine the security of the Service, the API or any data or information stored or transmitted using the Service.

You may not (i) interfere with, modify or disable any features, functionality or security controls of the Service or the API: (ii) defeat, avoid, bypass, remove, deactivate or otherwise circumvent any protection mechanisms for the Service or the API; or (iii) reverse engineer, decompile, disassemble or derive source code, underlying ideas, algorithms, structure or organizational form from the Service or the API.

You are solely responsible (and Localist has no responsibility or liability of any kind), for the content, development, operation, or maintenance of Localist Applications. Without limiting the foregoing, you will be solely responsible for (i) the technical installation and operation of your Localist Applications; (ii) creating and displaying information and content on, through or within your Localist Applications; (iii) ensuring that your Localist Applications do not violate or infringe the Intellectual Property Rights of any third party; and (iv) ensuring that your Localist Applications do not contain or introduce Malicious Software into the Service, the API, or any data stored or transmitted using the Service.

You must respect and comply with the technical and policy-implemented limitations of the API and the restrictions Localist designs or informs you of in accessing or using the API or designing and implementing Localist Applications. Without limiting the foregoing, you may not violate any explicit rate limitations on calling or otherwise utilizing the API.

To the extent you develop or implement Localist Applications that transmit or otherwise use or access the API to transmit Your Content outside the Service, you will be responsible for any required notification to or consent of Agents or End Users that their data will be transmitted outside the Service. Localist is not responsible for the privacy, security or integrity of Your Content to the extent it is transmitted outside the Service by you or your Localist Applications using the API.

Recent Changes

August 15, 2023

• Added endpoints for retrieving ticket and ticket group definitions for an Event.

April 8, 2022

• Added kind and conference_event_id attributes to Events.

March 24, 2020

• Added support for experiences to Events.
  • Added status, experience, stream_url, stream_info, and stream_embed_code attributes to Events.
  • Added experience parameter to event listing.

April 9, 2018

• Added status and checked_in_at attributes to attendances.

March 14, 2018

Released API version 2.2.

• Events
  • Changed group_id output to groups
  • Changed deparment_id output to departments

August 14, 2017

• Added for option to the event list method

July 6, 2017

• Added updated_at attribute, updated_before and updated_after parameters to attendances.

February 14, 2017

• Added attendances endpoints to the API
• Added authentication section

October 4, 2016

• Added localist_ics_url attribute to event output

March 22, 2016

• Added allows_attendance attribute to event output
• Clarified start and end range behavior on event methods
• Documented recurring option on event list method

January 14, 2016

• Added statistics endpoints to the API

October 8, 2013

Released API version 2.1.

• General
  • Added access to places, groups, departments and photos
  • Made HTML descriptions available in responses (starting with version 2.1)
  • Increased maximum page size to 100
  • Added direction parameter to control sort order
• Events
  • Added exclude_type option to list and search methods
  • Added created_before and created_after options to list method
  • Added match option to list method
  • Added sort options created and updated
  • Added photo_id and detail_views attributes to output

July 2, 2013

• Added all_custom_fields option to APIv2 event list and event search methods.

June 20, 2013

• Added ticket_url and ticket_cost fields to APIv2 event output.

May 8, 2013

• Added featured field to APIv2 event output.

May 7, 2013

• Added featured option to APIv2 event list method.

May 1, 2013

• Added all_custom_fields option to APIv2 event methods.

October 1, 2012

• Added require_all option to APIv2 event list method.

September 27, 2012

• Added created_by and updated_by fields to APIv2 event output.

July 16, 2012

• Added group_name and department_name fields to APIv2 event output.

Authentication

Authentication is optional to read data from the API. However, a subset of OAuth 2 is supported for access private data.

Calendar administrators must generate access tokens via the admin dashboard; there is no “authorize this app” support at this time.

Most API methods support anonymous access. If authentication is required, an anonymous request will return a response with the 401 status code, with a JSON object in the body describing the error. See the response errors section for further details.

Some requests require additional scopes, which grant the access token elevated permissions to access data. A list of the scopes is available below.

Making an Authenticated Request

All requests including an access token must be made over HTTPS.

A request can provide an access token using one of two methods:

1. By using the Authorization request header, specifying the Bearer scheme and the access token:

   Authorization: Bearer your_access_token
   

2. By providing the access token as the value of the access_token request parameter:

   https://CALENDAR-URL/api/2/events?access_token=your_access_token
   

Getting Access Tokens

A calendar administrator must generate the access tokens via the admin dashboard, however they can be assigned to any user on the calendar.

Each access token is associated with an app, which is also managed via the admin dashboard.

To get an access token, you must create an app and then an access token.

In the admin dashboard, app management can be accessed from the “Apps” item under the “Settings” menu.

Creating an App

1. From the admin dashboard, choose “Apps” from the “Settings” menu.
2. Choose “+ Add App”
3. Provide a name and URL for the new app. Both fields are required.
4. Click “Save Changes”

Creating and Viewing Access Tokens

From app management, either create an app as described above or choose an existing app, and click the “Access Tokens” button in the status bar.

A list of access tokens for the chosen app are shown, along with the associated user, scopes, and expiration time.

Once created, an access token can only be revoked by clicking the red “X” button next to it.

To create an access token, click “+ Create Access Token” above the listing. Select a user by email address, and if desired set an expiration date and appropriate scopes, then click “Create Token”. The created access token will then be displayed, and can immediately be used for the API.

Authentication Scopes

All access tokens have access to event data. When an access token is provided, the request acts as if a user is logged in, providing access to events marked as “Visible Only when Logged In”.

To access attendance or user data, the access token must be authorized with additional scopes:

Response Format

All responses are in JSON format. When representing an object, it is formatted as a hash with one element, with the key of the object type, and the value being a hash of the attributes of the object. For example, a event is represented like this:

{
  "event": {
    "id": 1,
    "name": "My Event",
    // other attributes
  }
}

Fields with a missing or blank value are not gauranteed to be present in the response. Your code should handle this situation, as the inclusion of empty fields in the response may change at any time.

Response Codes

The success or failure of the request is indicated using the HTTP status codes. In general, a 2xx code indicates success, while a 4xx code indicates failure.

Response Errors

Error responses (4xx status codes) contain an error hash in the body with the error message and code. For example:

{
  "status": "error",
  "request": "/api/2/events/123",
  "error": "Not Found: Couldn't find Event with id=123",
  "code": "not_found"
}

The error attribute contains an error message. The code attribute contains a string indicating the type of error:

Note: Responses with codes 403, 404 and 500 may return a HTML body instead of JSON. Your client should be prepared to handle this.

Geo Info

Contains structured geographic information, usually representing a specific point. Any or all of these elements may be missing if the address was not recognized.

{
  "city": "Ithaca",
  "country": "US",
  "latitude": 42.4425,
  "longitude": -76.4857,
  "state": "NY",
  "street": "430 College Ave",
  "zip": "14850"
}

Paging

Contains information about result set paging, including the total number of pages. Page numbers start at 1.

{
  "current": 1,
  "size": 10,
  "total": 1
}

Filters

Represents the assigned filter items on an object.

An object can have multiple filter types (such as “Event Type” or “Department”), each of which can have multiple filter items assigned.

You can use the appropriate labels method on a resource to retrieve the displayed names of the filter types and custom fields.

The hash’s keys represent the filter types that are assigned, with the value being an array of the assigned filters.

{
  "departments": [
    {
      "id": 4859,
      "name": "School of Continuing Education and Summer Sessions"
    }
  ],
  "event_types": [
    {
      "id": 4262,
      "name": "Music"
    }
  ]
}

Recent Activity

Recent activity covers three types of objects representing the content that can be posted by a user: comments, reviews, and photos. Not all types are available on all objects.

The recent activity result is a mixed array of the three types.

In addition, there are two common result attributes among the responses, user and on.

User

Contains information about the user who posted the item.

{
  "id": 12345,
  "photo_url": "http://images.localist.com/images/main/person_huge.png",
  "profile_url": "http://example.localist.com/johndoe",
  "visible_name": "John Doe"
}

On

Identifies what object the review or comment was posted to. Since a photo can be associated with multiple objects, it does not contain this information.

{
  "id": 73502,
  "type": "event"
}

Comment

Represents a comment posted by a user.

{
  "comment": {
    "body": "Will this event be live on the Web?",
    "created_at": "2012-04-19T13:35:50Z",
    "id": 1422,
    "on": {
      "id": 73502,
      "type": "event"
    },
    "updated_at": "2012-04-19T13:35:50Z",
    "user": {
      "id": 12345,
      "photo_url": "http://images.localist.com/images/main/person_huge.png",
      "profile_url": "http://example.localist.com/johndoe",
      "visible_name": "John Doe"
    },
    "when": "2012-04-19T09:35:50Z"
  }
}

Review

Represents a review posted by a user. Identical to a comment with the addition of the rating key.

{
  "review": {
    "body": "It was great fun to see Venus directly in front of the sun.",
    "created_at": "2012-06-06T18:50:25Z",
    "id": 1443,
    "on": {
      "id": 76119,
      "type": "event"
    },
    "rating": 1,
    "updated_at": "2012-06-06T18:50:25Z",
    "user": {
      "id": 12345,
      "photo_url": "http://images.localist.com/images/main/person_huge.png",
      "profile_url": "http://example.localist.com/johndoe",
      "visible_name": "John Doe"
    },
    "when": "2012-06-05T00:00:00Z"
  }
}

Photo

Represents a photo entry in a recent activity list.

Since a photo can be associated with multiple objects, the on data is not provided.

Note: This is a slightly different format than the photo resource returns, as it includes more context for a recent activity listing.

{
  "photo": {
    "caption": "",
    "id": 626,
    "photo_url": "http://images.localist.com/photo/000/000/626/huge/jSNHHDAb_6Yp1_Li.jpg?1339699432",
    "updated_at": "2012-06-14T18:43:52Z",
    "user": {
      "photo_url": "http://images.localist.com/images/main/person_huge.png",
      "profile_url": "http://example.localist.com/johndoe",
      "visible_name": "John Doe"
    },
    "when": "2012-06-14T18:43:52Z"
  }
}

Describes the available resources, their response formats, and associated methods. Variables in resource URLs are listed in all capital letters.

Note: All output samples have been reformatted for clarity, and some responses and values have been truncated.

Organizations

An organization is the root level that all content is attached to. A calendar always has one organization.

Format

{
  "organization": {
    "id": 55,
    "name": "WTMD",
    "urlname": "wtmd",
    "description": null,
    "time_zone": "Eastern Time (US & Canada)",
    "photo_id": null,
    "localist_url": "http://events.wtmd.org/",
    "photo_url": "http://images-cf.localist.com/assets/main/person_huge-10cb90..."
  }
}

List

Resource: GET /organizations

Returns a paged listing of organizations on this calendar.

Example Request: GET http://CALENDAR-URL/api/2/organizations

{
  "organizations": [
    {
      "organization": {
        "id": 55,
        "name": "WTMD",
        "urlname": "wtmd",
        "description": null,
        "time_zone": "Eastern Time (US & Canada)",
        "photo_id": null,
        "localist_url": "http://events.wtmd.org/",
        "photo_url": "http://images-cf.localist.com/assets/main/person_huge-10cb90..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 1
  }
}

Get

Resource: GET /organizations/ORGANIZATION_ID

Retrieve details about one organization.

Example Request: GET http://CALENDAR-URL/api/2/organizations/55

{
  "organization": {
    "id": 55,
    "name": "WTMD",
    "urlname": "wtmd",
    "description": null,
    "time_zone": "Eastern Time (US & Canada)",
    "photo_id": null,
    "localist_url": "http://events.wtmd.org/",
    "photo_url": "http://images-cf.localist.com/assets/main/person_huge-10cb90..."
  }
}

Communities List

Resource: GET /organizations/ORGANIZATION_ID/communities

Returns a paged listing of the communities associated with this organization.

Example Request: GET http://CALENDAR-URL/api/2/organziations/11/communities

{
  "communities": [
    {
      "community": {
        "id": 62,
        "name": "Sacramento",
        "urlname": "sacramento",
        "description": "",
        "time_zone": "Pacific Time (US & Canada)",
        "photo_id": null,
        "school_id": 11,
        "localist_url": "https://calendar.pacific.edu/sacramento",
        "photo_url": "https://d3e1o4bcbhmj8g.cloudfront.net/assets/main/person_hug..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 1
  }
}

Communities

A community represents a separate location within an organization, such as a college campus, association chapter, or regional market.

Format

{
  "community": {
    "id": 62,
    "name": "Sacramento",
    "urlname": "sacramento",
    "description": "",
    "time_zone": "Pacific Time (US & Canada)",
    "photo_id": null,
    "school_id": 11,
    "localist_url": "https://calendar.pacific.edu/sacramento",
    "photo_url": "https://d3e1o4bcbhmj8g.cloudfront.net/assets/main/person_hug..."
  }
}

List

Resource: GET /organizations/ORGANIZATION_ID/communities

Returns a paged listing of communities in the specified organization.

Example Request: GET http://CALENDAR-URL/api/2/organizations/11/communities

{
  "communities": [
    {
      "community": {
        "id": 62,
        "name": "Sacramento",
        "urlname": "sacramento",
        "description": "",
        "time_zone": "Pacific Time (US & Canada)",
        "photo_id": null,
        "school_id": 11,
        "localist_url": "https://calendar.pacific.edu/sacramento",
        "photo_url": "https://d3e1o4bcbhmj8g.cloudfront.net/assets/main/person_hug..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 1
  }
}

Get

Resource: GET /organizations/ORGANIZATION_ID/communities/COMMUNITY_ID

Retrieve details about one community.

Example Request: GET http://CALENDAR-URL/api/2/organizations/11/community/62

{
  "community": {
    "id": 62,
    "name": "Sacramento",
    "urlname": "sacramento",
    "description": "",
    "time_zone": "Pacific Time (US & Canada)",
    "photo_id": null,
    "school_id": 11,
    "localist_url": "https://calendar.pacific.edu/sacramento",
    "photo_url": "https://d3e1o4bcbhmj8g.cloudfront.net/assets/main/person_hug..."
  }
}

Events

These resources provide access to information about events.

Format

{
  "event": {
    "id": 188155,
    "title": "Amy Sherald: Paintings",
    "url": "http://www.rflewismuseum.org/exhibitions/special",
    "updated_at": "2015-08-14T17:23:33-04:00",
    "created_at": "2013-08-26T02:26:44-04:00",
    "facebook_id": null,
    "first_date": "2013-09-14",
    "last_date": "2013-12-29",
    "hashtag": "",
    "urlname": "amy_sherald_paintings",
    "user_id": 52182,
    "directions": "",
    "allows_reviews": true,
    "allows_attendance": true,
    "location": "Reginald F. Lewis of Maryland African American History and C...",
    "room_number": "",
    "location_name": "Reginald F. Lewis of Maryland African American History and C...",
    "created_by": null,
    "updated_by": null,
    "city_id": 1,
    "neighborhood_id": 58,
    "school_id": 55,
    "campus_id": null,
    "recurring": true,
    "free": true,
    "private": false,
    "verified": true,
    "rejected": false,
    "sponsored": false,
    "venue_id": null,
    "ticket_url": "",
    "ticket_cost": "",
    "keywords": [

    ],
    "tags": [

    ],
    "description_text": "Known for her life-sized fantastical portraits of African Am...",
    "photo_id": 76525,
    "detail_views": 316,
    "address": "830 E. Pratt St. Baltimore, MD 21202",
    "description": "<p class=\"description\">Known for her life-sized fantastical ...",
    "featured": true,
    "geo": {
      "latitude": "39.287266",
      "longitude": "-76.603813",
      "street": "830 East Pratt Street",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "zip": "21202"
    },
    "filters": {
      "event_types": [
        {
          "name": "Arts & Culture",
          "id": 20196
        }
      ]
    },
    "custom_fields": {
    },
    "localist_url": "http://events.wtmd.org/event/amy_sherald_paintings",
    "photo_url": "http://images-cf.localist.com/photos/76525/huge/195a2ae18388...",
    "venue_url": null,
    "event_instances": [
      {
        "event_instance": {
          "id": 452831,
          "ranking": 0,
          "event_id": 188155,
          "start": "2013-09-14T10:00:00-04:00",
          "end": "2013-09-14T17:00:00-04:00",
          "all_day": false
        }
      }
    ]
  }
}

Event Instance Format

Represents information about one specific instance of an event. The attendance and num_attending attributes may not be present.

{
  "event_instance": {
    "attending": "none",
    "num_attending": 0,
    "id": 237631,
    "ranking": 0,
    "event_id": 81300,
    "start": "2013-09-14T21:00:00-04:00",
    "end": null,
    "all_day": false
  }
}

Note: The start timestamp always includes a time, even if none was specified on the event. The all_day flag will be true if there is no defined start time.

List

Resource: GET /events

Returns a paged list of events.

Without any additional parameters, only events occurring today are returned.

The result hash includes an array of event objects in the events key, a date key describing the date range returned, and a page key with paging information.

Locality Parameters

These parameters restrict the results based on location.

Date Parameters

Control the range of events to return.

All dates should be specified as YYYY-MM-DD (2013-09-20). The maximum date range supported is 365 days. Longer ranges will be truncated to 365 days from start. The range defined by start and end does not include the date specified in end.

Page Parameters

Specifies the size and offset of the results.

Filter Parameters

Restrict the returned events based on filter items, tags and keywords assigned.

To specify multiple values for type, keyword or exclude_type, the parameter may be repeated with brackets ([]) after the name.

For instance, to request both keyword kw1 and kw2, use a URL similar to: http://CALENDAR-URL/api/2/events?keyword[]=kw1&keyword[]=kw2.

Output Parameters

Note: Sorting by distance is only supported when near is specified.

Example Request: GET http://CALENDAR-URL/api/2/events

{
  "events": [
    {
      "event": {
        "event_instances": [
          {
            "event_instance": {
              "id": 1206819,
              "ranking": 0,
              "event_id": 428144,
              "start": "2015-09-30T00:00:00-04:00",
              "end": "2015-10-01T00:00:00-04:00",
              "all_day": false
            }
          }
        ],
        "id": 428144,
        "title": "FarmSprouts Preschool Program",
        "url": "http://www.marylandagriculture.org/farm-sprouts-preschool-pr...",
        "updated_at": "2015-09-30T06:00:18-04:00",
        "created_at": "2015-03-25T15:05:42-04:00",
        "facebook_id": null,
        "first_date": "2015-04-01",
        "last_date": "2015-11-18",
        "hashtag": "",
        "urlname": "maryland_agricultural_resource_council_presents",
        "user_id": 155267,
        "directions": "",
        "allows_reviews": true,
        "allows_attendance": true,
        "location": "The Ag Center in Cockeysville",
        "room_number": "",
        "location_name": "The Ag Center in Cockeysville",
        "created_by": null,
        "updated_by": null,
        "city_id": 1,
        "neighborhood_id": null,
        "school_id": 55,
        "campus_id": null,
        "recurring": true,
        "free": true,
        "private": false,
        "verified": true,
        "rejected": false,
        "sponsored": false,
        "venue_id": null,
        "ticket_url": "",
        "ticket_cost": "",
        "keywords": [

        ],
        "tags": [

        ],
        "description_text": "Maryland Agricultural Resource Council Presents FarmSprouts ...",
        "photo_id": 263898,
        "detail_views": 253,
        "address": "1114 Shawan Road, Cockeysville, MD 21030-1385",
        "description": "<p>Maryland Agricultural Resource Council Presents FarmSprou...",
        "featured": false,
        "geo": {
          "latitude": "39.50338",
          "longitude": "-76.685768",
          "street": "1114 Shawan Road",
          "city": "Cockeysville",
          "state": "MD",
          "country": "US",
          "zip": "21030"
        },
        "filters": {
          "event_types": [
            {
              "name": "Community",
              "id": 20053
            }
          ]
        },
        "custom_fields": {
        },
        "localist_url": "http://events.wtmd.org/event/maryland_agricultural_resource_...",
        "photo_url": "http://images-cf.localist.com/photos/263898/huge/28d6ef0052c...",
        "venue_url": null
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 27
  },
  "date": {
    "first": "2015-09-30",
    "last": "2015-10-30"
  }
}

Search

Resource: GET /events/search

Searches for events with the search term specified in search.

Supports all parameters supported by event list, except for keyword, match, created_before, created_after, for. Keywords and tags are searched as part of search.

Sorting by created and updated is not supported.

The response format is the same as for event list.

Example Request: GET http://CALENDAR-URL/api/2/events/search?search=concert

{
  "events": [
    {
      "event": {
        "event_instances": [
          {
            "event_instance": {
              "id": 1206819,
              "ranking": 0,
              "event_id": 428144,
              "start": "2015-09-30T00:00:00-04:00",
              "end": "2015-10-01T00:00:00-04:00",
              "all_day": false
            }
          }
        ],
        "id": 428144,
        "title": "FarmSprouts Preschool Program",
        "url": "http://www.marylandagriculture.org/farm-sprouts-preschool-pr...",
        "updated_at": "2015-09-30T06:00:18-04:00",
        "created_at": "2015-03-25T15:05:42-04:00",
        "facebook_id": null,
        "first_date": "2015-04-01",
        "last_date": "2015-11-18",
        "hashtag": "",
        "urlname": "maryland_agricultural_resource_council_presents",
        "user_id": 155267,
        "directions": "",
        "allows_reviews": true,
        "allows_attendance": true,
        "location": "The Ag Center in Cockeysville",
        "room_number": "",
        "location_name": "The Ag Center in Cockeysville",
        "created_by": null,
        "updated_by": null,
        "city_id": 1,
        "neighborhood_id": null,
        "school_id": 55,
        "campus_id": null,
        "recurring": true,
        "free": true,
        "private": false,
        "verified": true,
        "rejected": false,
        "sponsored": false,
        "venue_id": null,
        "ticket_url": "",
        "ticket_cost": "",
        "keywords": [

        ],
        "tags": [

        ],
        "description_text": "Maryland Agricultural Resource Council Presents FarmSprouts ...",
        "photo_id": 263898,
        "detail_views": 253,
        "address": "1114 Shawan Road, Cockeysville, MD 21030-1385",
        "description": "<p>Maryland Agricultural Resource Council Presents FarmSprou...",
        "featured": false,
        "geo": {
          "latitude": "39.50338",
          "longitude": "-76.685768",
          "street": "1114 Shawan Road",
          "city": "Cockeysville",
          "state": "MD",
          "country": "US",
          "zip": "21030"
        },
        "filters": {
          "event_types": [
            {
              "name": "Community",
              "id": 20053
            }
          ]
        },
        "custom_fields": {
        },
        "localist_url": "http://events.wtmd.org/event/maryland_agricultural_resource_...",
        "photo_url": "http://images-cf.localist.com/photos/263898/huge/28d6ef0052c...",
        "venue_url": null
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 27
  },
  "date": {
    "first": "2015-09-30",
    "last": "2015-10-30"
  }
}

Get

Resource: GET /events/EVENT_ID

Returns details about the event specified by event_id.

If requested, attendees will be included in an attendees attribute, recent activity will be in an recent_activity attribute and attendance info will be on the event instance.

Example Request: GET http://CALENDAR-URL/api/2/events/188155

{
  "event": {
    "id": 188155,
    "title": "Amy Sherald: Paintings",
    "url": "http://www.rflewismuseum.org/exhibitions/special",
    "updated_at": "2015-08-14T17:23:33-04:00",
    "created_at": "2013-08-26T02:26:44-04:00",
    "facebook_id": null,
    "first_date": "2013-09-14",
    "last_date": "2013-12-29",
    "hashtag": "",
    "urlname": "amy_sherald_paintings",
    "user_id": 52182,
    "directions": "",
    "allows_reviews": true,
    "allows_attendance": true,
    "location": "Reginald F. Lewis of Maryland African American History and C...",
    "room_number": "",
    "location_name": "Reginald F. Lewis of Maryland African American History and C...",
    "created_by": null,
    "updated_by": null,
    "city_id": 1,
    "neighborhood_id": 58,
    "school_id": 55,
    "campus_id": null,
    "recurring": true,
    "free": true,
    "private": false,
    "verified": true,
    "rejected": false,
    "sponsored": false,
    "venue_id": null,
    "ticket_url": "",
    "ticket_cost": "",
    "keywords": [

    ],
    "tags": [

    ],
    "description_text": "Known for her life-sized fantastical portraits of African Am...",
    "photo_id": 76525,
    "detail_views": 316,
    "address": "830 E. Pratt St. Baltimore, MD 21202",
    "description": "<p class=\"description\">Known for her life-sized fantastical ...",
    "featured": true,
    "geo": {
      "latitude": "39.287266",
      "longitude": "-76.603813",
      "street": "830 East Pratt Street",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "zip": "21202"
    },
    "filters": {
      "event_types": [
        {
          "name": "Arts & Culture",
          "id": 20196
        }
      ]
    },
    "custom_fields": {
    },
    "localist_url": "http://events.wtmd.org/event/amy_sherald_paintings",
    "photo_url": "http://images-cf.localist.com/photos/76525/huge/195a2ae18388...",
    "venue_url": null,
    "event_instances": [
      {
        "event_instance": {
          "id": 452831,
          "ranking": 0,
          "event_id": 188155,
          "start": "2013-09-14T10:00:00-04:00",
          "end": "2013-09-14T17:00:00-04:00",
          "all_day": false
        }
      }
    ]
  }
}

Recent Activity

Resource: GET /events/EVENT_ID/activity

Returns a paged result set of recent activity on the event specified by event_id.

The activity key in the result is an array of activity items. The page key contains paging details.

Example Request: GET http://CALENDAR-URL/api/2/events/81300/activity

{
  "activity": [
    {
      "photo": {
        "caption": "",
        "id": 219,
        "photo_url": "http://images-cf.localist.com/photos/219/huge/bc33c6375295e5f1c324b3826d201c548ff52c39.jpg?1379709611",
        "updated_at": "2013-09-20T20:40:11Z",
        "user": {
          "id": 1,
          "photo_url": "http://images-cf.localist.com/photos/189/huge/fbe183f9caa62d281653b5a764e5f6e8fc1afe5f.jpg?1376942064",
          "profile_url": "http://example.localist.com/eric",
          "visible_name": "Eric"
        },
        "when": "2013-09-20T20:40:11Z"
      }
    },
    {
      "review": {
        "body": "awesome",
        "created_at": "2013-09-20T20:40:01Z",
        "id": 1473,
        "on": {
          "id": 81300,
          "type": "event"
        },
        "rating": 1,
        "updated_at": "2013-09-20T20:40:01Z",
        "user": {
          "id": 1,
          "photo_url": "http://images-cf.localist.com/photos/189/huge/fbe183f9caa62d281653b5a764e5f6e8fc1afe5f.jpg?1376942064",
          "profile_url": "http://example.localist.com/eric",
          "visible_name": "Eric"
        },
        "when": "2013-09-20T20:40:01Z"
      }
    },
    {
      "comment": {
        "body": "my comment",
        "created_at": "2013-09-20T20:39:54Z",
        "id": 1470,
        "on": {
          "id": 81300,
          "type": "event"
        },
        "updated_at": "2013-09-20T20:39:54Z",
        "user": {
          "id": 1,
          "photo_url": "http://images-cf.localist.com/photos/189/huge/fbe183f9caa62d281653b5a764e5f6e8fc1afe5f.jpg?1376942064",
          "profile_url": "http://example.localist.com/eric",
          "visible_name": "Eric"
        },
        "when": "2013-09-20T16:39:54Z"
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 1
  }
}

Attendees

Resource: GET /events/EVENT_ID/attendees

Returns the attendees on the event specified by event_id.

The attendees key will contain an array of user objects. Note that the user key for the object may also be external_attendee or private_user.

Attendees from external sources (such as Facebook) are represented by external_attendee. The localist_url attribute provides the best possible profile page, but may be absent. The id is unique to external attendees.

A user with privacy settings preventing details from being shown is represented by a private_user. id and localist_url are null in this case.

Example Request: GET http://CALENDAR-URL/api/2/events/81300/attendees

{
  "attendees": [
    {
      "user": {
        "id": 1,
        "localist_url": "http://example.localist.com/eric",
        "photo_url": "http://images-cf.localist.com/photos/189/huge/fbe183f9caa62d281653b5a764e5f6e8fc1afe5f.jpg?1376942064",
        "visible_name": "Eric"
      }
    },
    {
      "external_attendee": {
        "id": 297248,
        "localist_url": "http://www.facebook.com/111111111",
        "photo_url": "http://images-cf.localist.com/images/main/person_huge.png",
        "visible_name": "John Doe"
      }
    },
    {
      "private_user": {
        "id": null,
        "localist_url": null,
        "photo_url": "http://images-cf.localist.com/images/main/person_huge.png",
        "visible_name": "Private"
      }
    }
  ]
}

Attendance

Gets or modifies the user’s attendance status on the event. All attendance methods require a valid access token.

Get Attendance

Resource: GET /events/EVENT_ID/attendance

Requires authentication.

To retrieve attendance, perform a HTTP GET on this resource.

Returns a list of event instances the user is attending in the attendances key.

Example Request: GET http://CALENDAR-URL/api/2/events/81300/attendance

{
  "attendances": [
    {
      "event_instance": {
        "attending": "attending",
        "num_attending": 3,
        "id": 237632,
        "ranking": 0,
        "event_id": 81300,
        "start": "2013-09-20T21:00:00-04:00",
        "end": null,
        "all_day": false
      }
    }
  ]
}

Add Attendance

Resource: POST /events/EVENT_ID/attendance

Requires authentication.

To add attendance on an event, perform a HTTP POST on this resource, with either the event_instances_id or dates parameter. Both accept multiple values with array syntax (event_instances_id[] or dates[]). The parameters may be in either the URL or as the form data.

Example Request: POST http://CALENDAR-URL/api/2/events/81300/attendance?dates=2013-09-20

{
  "status": "success"
}

Remove Attendance

Resource: DELETE /events/EVENT_ID/attendance

Requires authentication.

To add attendance on an event, perform a HTTP DELETE on this resource, with either the event_instances_id or dates parameter. Both accept multiple values with array syntax (event_instances_id[] or dates[]). The parameters may be in either the URL or as the form data.

Example Request: DELETE http://CALENDAR-URL/api/2/events/81300/attendance?dates=2013-09-20

{
  "status": "success"
}

Filters

Resource: GET /events/filters

Returns the list of event filter items. The ID can be used in the type parameter to /events.

The parent_id attribute represents the parent filter item, if a child filter.

Example Request: GET http://CALENDAR-URL/api/2/events/filters

{
  "event_types": [
    {
      "id": 20050,
      "name": "Music",
      "parent_id": null
    }
  ],
  "departments": [
    {
      "id": 20860,
      "name": "WTMD Welcomes",
      "parent_id": null
    }
  ]
}

Labels

Resource: GET /events/labels

Returns the display labels for filter types and custom fields. The key is the identifier (as used in other responses) and value is the user-friendly label.

Example Request: GET http://CALENDAR-URL/api/2/events/labels

{
  "custom_fields": {
  },
  "filters": {
    "event_types": "Event Types",
    "departments": "Departments"
  }
}

Event Tickets

These resources provide information about the defined Register tickets and ticket groups on an event.

Ticket Format

Represents a purchasable ticket on an event.

The final cost of a ticket is not entirely represented here, as the fees depend on the payment method used. Some payment methods do not support customer_pays_fees, regardless of the value of that flag here.

donation tickets allow the user to specify the amount paid for the ticket. The allowable range is controlled by min_price and max_price. price is not used for donation tickets.

All prices are specified in an integer number of cents, that is, a value of 100 represents $1.00.

The ticket type influences the messaging and confirmation/receipt mails after checkout. The attributes related to the content of these messages are intentionally omitted here.

{
  "ticket": {
    "id": 43969289786158,
    "name": "In-Person paid (pass fees)",
    "description": null,
    "price": 1000,
    "min_price": null,
    "max_price": null,
    "donation": false,
    "availability_start": null,
    "availability_finish": null,
    "purchase_minimum": null,
    "purchase_limit": null,
    "customer_pays_fees": true,
    "ticket_type": "in_person",
    "ticket_group_id": 43969289784108,
    "position": 1
  }
}

Ticket Group Format

A ticket group is a container for event tickets. In the checkout process, this is represented by a divider with the name.

{
  "ticket_group": {
    "id": 43969289784108,
    "name": "Ticket Group",
    "position": 0
  }
}

List Tickets

Resource: GET /events/EVENT_ID/tickets

Returns the list of tickets defined on an event.

The result hash includes an array of ticket objects in the tickets key.

The result includes all active, visible tickets defined on the event, ordered by position.

Example Request: GET http://CALENDAR-URL/api/2/events/EVENT_ID/tickets

{
  "tickets": [
    {
      "ticket": {
        "id": 43969296682808,
        "name": "Purchase limits",
        "description": null,
        "price": 0,
        "min_price": null,
        "max_price": null,
        "donation": false,
        "availability_start": null,
        "availability_finish": null,
        "purchase_minimum": 5,
        "purchase_limit": 10,
        "customer_pays_fees": true,
        "ticket_type": "in_person",
        "ticket_group_id": null,
        "position": 0
      }
    }
  ]
}

List Ticket Groups

Resource: GET /events/EVENT_ID/ticket_groups

Returns the list of ticket groups defined on an event.

The result hash includes an array of ticket group objects in the tickets key.

Example Request: GET http://CALENDAR-URL/api/2/events/EVENT_ID/ticket_groups

{
  "ticket_groups": [
    {
      "ticket_group": {
        "id": 43969289784108,
        "name": "Ticket Group",
        "position": 0
      }
    }
  ]
}

Places

This resource provides access to place data.

Format

{
  "place": {
    "id": 66194,
    "name": "1st Mariner Arena",
    "type": "Business",
    "neighborhood_id": 4,
    "city_id": "1",
    "campus_id": null,
    "school_id": 55,
    "created_at": "2013-04-05T14:02:52-04:00",
    "updated_at": "2013-04-22T13:07:32-04:00",
    "time_zone": "Eastern Time (US & Canada)",
    "photo_id": 60978,
    "ranking": 0,
    "twitter_name": null,
    "facebook_id": null,
    "foursquare_id": null,
    "urlname": "1stmarinerarena",
    "verified": true,
    "tags": [

    ],
    "keywords": [

    ],
    "description_text": "1st Mariner Arena is City-owned facility which hosts an aver...",
    "description": "1st Mariner Arena is City-owned facility which hosts an aver...",
    "geo": {
      "latitude": "39.288494",
      "longitude": "-76.618698",
      "street": "201 West Baltimore Street",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "zip": "21201"
    },
    "url": "",
    "directions": null,
    "phone": "",
    "hours": "",
    "parking": null,
    "sponsored": false,
    "address": "201 W Baltimore St, Baltimore, MD 21201, USA",
    "filters": {
    },
    "custom_fields": {
    },
    "localist_url": "http://events.wtmd.org/1stmarinerarena",
    "photo_url": "http://images-cf.localist.com/photos/60978/huge/0c21bfeaedf9..."
  }
}

List

Resource: GET /places

Returns a paged list of places. By default, includes all places available on a calendar, but can be limited using the locality parameters.

The places can be further limited based on assigned filters.

The result hash includes an array of place objects in the places key, and a page key with paging information.

Locality Parameters

These parameters restrict the results based on location.

Page Parameters

Specifies the size and offset of the results.

Filter Parameters

Restrict the returned places based on filter items, tags and keywords assigned.

To specify multiple values for type, keyword or exclude_type, the parameter may be repeated with brackets ([]) after the name.

For instance, to request both keyword kw1 and kw2, use a URL similar to: http://CALENDAR-URL/api/2/places?keyword[]=kw1&keyword[]=kw2.

Output Parameters

Note: Sorting by distance is only supported when near is specified.

Example Request: GET http://CALENDAR-URL/api/2/places

{
  "places": [
    {
      "place": {
        "id": 66398,
        "name": "Abbey Burger Bistro",
        "type": "Business",
        "neighborhood_id": 3,
        "city_id": "1",
        "campus_id": null,
        "school_id": 55,
        "created_at": "2013-04-05T14:06:14-04:00",
        "updated_at": "2013-04-22T13:09:16-04:00",
        "time_zone": "Eastern Time (US & Canada)",
        "photo_id": 61177,
        "ranking": 0,
        "twitter_name": null,
        "facebook_id": null,
        "foursquare_id": null,
        "urlname": "abbeyburgerbistro",
        "verified": true,
        "tags": [

        ],
        "keywords": [

        ],
        "description_text": "In need of an upscale burger joint? Look no further than The...",
        "description": "In need of an upscale burger joint? Look no further than The...",
        "geo": {
          "latitude": "39.27721",
          "longitude": "-76.612915",
          "street": "1041 Marshall Street",
          "city": "Baltimore",
          "state": "MD",
          "country": "US",
          "zip": "21230"
        },
        "url": "",
        "directions": null,
        "phone": "",
        "hours": "",
        "parking": null,
        "sponsored": false,
        "address": "1041 Marshall St, Baltimore, MD 21230, USA",
        "filters": {
        },
        "custom_fields": {
        },
        "localist_url": "http://events.wtmd.org/abbeyburgerbistro",
        "photo_url": "http://images-cf.localist.com/photos/61177/huge/5543d0ed043d..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 55
  }
}

Search

Resource: GET /places/search

Searches for places with the search term specified in search.

Supports all parameters supported by place list, except for keyword, created_before, created_after. Keywords are searched as part of search.

Sorting by created and updated is not supported.

The response format is the same as for place list.

Example Request: GET http://CALENDAR-URL/api/2/places/search?search=arena

{
  "places": [
    {
      "place": {
        "id": 66448,
        "name": "Sheraton Baltimore City Center Hotel",
        "type": "Business",
        "neighborhood_id": 4,
        "city_id": "1",
        "campus_id": null,
        "school_id": 55,
        "created_at": "2013-04-05T14:07:18-04:00",
        "updated_at": "2013-04-22T13:09:51-04:00",
        "time_zone": "Eastern Time (US & Canada)",
        "photo_id": 61225,
        "ranking": 0,
        "twitter_name": null,
        "facebook_id": null,
        "foursquare_id": null,
        "urlname": "sheratonbaltimore",
        "verified": true,
        "tags": [

        ],
        "keywords": [

        ],
        "description_text": "Sheraton Baltimore City Center Hotel offers a great location...",
        "description": "Sheraton Baltimore City Center Hotel offers a great location...",
        "geo": {
          "latitude": "39.290398",
          "longitude": "-76.617096",
          "street": "101 West Fayette Street",
          "city": "Baltimore",
          "state": "MD",
          "country": "US",
          "zip": "21201"
        },
        "url": "",
        "directions": null,
        "phone": "",
        "hours": "",
        "parking": null,
        "sponsored": false,
        "address": "101 W Fayette St, Baltimore, MD 21201, USA",
        "filters": {
        },
        "custom_fields": {
        },
        "localist_url": "http://events.wtmd.org/sheratonbaltimore",
        "photo_url": "http://images-cf.localist.com/photos/61225/huge/0cd0bef9e86b..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 1
  }
}

Get

Resource: GET /places/PLACE_ID

Returns details about the place specified by place_id.

Example Request: GET http://CALENDAR-URL/api/2/places/66194

{
  "place": {
    "id": 66194,
    "name": "1st Mariner Arena",
    "type": "Business",
    "neighborhood_id": 4,
    "city_id": "1",
    "campus_id": null,
    "school_id": 55,
    "created_at": "2013-04-05T14:02:52-04:00",
    "updated_at": "2013-04-22T13:07:32-04:00",
    "time_zone": "Eastern Time (US & Canada)",
    "photo_id": 60978,
    "ranking": 0,
    "twitter_name": null,
    "facebook_id": null,
    "foursquare_id": null,
    "urlname": "1stmarinerarena",
    "verified": true,
    "tags": [

    ],
    "keywords": [

    ],
    "description_text": "1st Mariner Arena is City-owned facility which hosts an aver...",
    "description": "1st Mariner Arena is City-owned facility which hosts an aver...",
    "geo": {
      "latitude": "39.288494",
      "longitude": "-76.618698",
      "street": "201 West Baltimore Street",
      "city": "Baltimore",
      "state": "MD",
      "country": "US",
      "zip": "21201"
    },
    "url": "",
    "directions": null,
    "phone": "",
    "hours": "",
    "parking": null,
    "sponsored": false,
    "address": "201 W Baltimore St, Baltimore, MD 21201, USA",
    "filters": {
    },
    "custom_fields": {
    },
    "localist_url": "http://events.wtmd.org/1stmarinerarena",
    "photo_url": "http://images-cf.localist.com/photos/60978/huge/0c21bfeaedf9..."
  }
}

Filters

Resource: GET /places/filters

Returns the list of place filter items. The ID can be used in the type parameter to /places.

The parent_id attribute represents the parent filter item, if a child item.

Example Request: GET http://CALENDAR-URL/api/2/places/filters

{
  "business_type": [
    {
      "id": 2335,
      "name": "Bar",
      "parent_id": null
    }
  ]
}

Labels

Resource: GET /places/labels

Returns the display labels for filter types and custom fields. The key is the identifier (as used in other responses) and value is the user-friendly label.

Example Request: GET http://CALENDAR-URL/api/2/places/labels

{
  "custom_fields": {
  },
  "filters": {
    "business_type": "Place Types"
  }
}

Groups

This resource provides access to groups.

Format

{
  "group": {
    "id": 3948,
    "name": "CUWinds",
    "urlname": "cuwinds",
    "created_at": "2012-10-09T09:21:45-04:00",
    "updated_at": "2012-10-10T08:49:41-04:00",
    "photo_id": null,
    "school_id": 10,
    "campus_id": null,
    "url": "http://www.cuwinds.com/",
    "tags": [

    ],
    "description_text": "CU WINDS unites Cornell University students who seek remarka...",
    "description": "CU WINDS unites Cornell University students who seek remarka...",
    "filters": {
    },
    "custom_fields": {
    },
    "localist_url": "http://events.cornell.edu/group/cuwinds",
    "photo_url": "http://images-cf.localist.com/assets/main/business_huge-18aa..."
  }
}

List

Resource: GET /groups

Returns a paged list of groups. By default, includes all groups available on a calendar, but can be limited using the locality parameters.

The groups can be further limited based on assigned filters.

The result hash includes an array of group objects in the groups key, and a page key with paging information.

Locality Parameters

These parameters restrict the results based on location.

Page Parameters

Specifies the size and offset of the results.

Filter Parameters

Restrict the returned groups based on the filter items, tags and keywords assigned.

To specify multiple values for type, keyword or exclude_type, the parameter may be repeated with brackets ([]) after the name.

For instance, to request both keyword kw1 and kw2, use a URL similar to: http://CALENDAR-URL/api/2/groups?keyword[]=kw1&keyword[]=kw2.

Output Parameters

Note: Sorting by distance is only supported when near is specified.

Example Request: GET http://CALENDAR-URL/api/2/groups

{
  "groups": [
    {
      "group": {
        "id": 4236,
        "name": "Cornell Minds Matter",
        "urlname": "cornell_minds_matter",
        "created_at": "2013-04-01T09:14:57-04:00",
        "updated_at": "2013-04-01T09:14:57-04:00",
        "photo_id": null,
        "school_id": 10,
        "campus_id": null,
        "url": "",
        "tags": [

        ],
        "description_text": "",
        "description": "",
        "filters": {
        },
        "custom_fields": {
        },
        "localist_url": "http://events.cornell.edu/group/cornell_minds_matter",
        "photo_url": "http://images-cf.localist.com/assets/main/business_huge-18aa..."
      }
    }
  ],
  "page": {
    "current": 1,
    "size": 10,
    "total": 4
  }
}

Get

Resource: GET /groups/GROUP_ID

Returns details about the group specified by group_id.

Example Request: GET http://CALENDAR-URL/api/2/groups/3948

{
  "group": {
    "id": 3948,
    "name": "CUWinds",
    "urlname": "cuwinds",
    "created_at": "2012-10-09T09:21:45-04:00",
    "updated_at": "2012-10-10T08:49:41-04:00",
    "photo_id": null,
    "school_id": 10,
    "campus_id": null,
    "url": "http://www.cuwinds.com/",
    "tags": [

    ],
    "description_text": "CU WINDS unites Cornell University students who seek remarka...",
    "description": "CU WINDS unites Cornell University students who seek remarka...",
    "filters": {
    },
    "custom_fields": {
    },
    "localist_url": "http://events.cornell.edu/group/cuwinds",
    "photo_url": "http://images-cf.localist.com/assets/main/business_huge-18aa..."
  }
}

Filters

Resource: GET /groups/filters

Returns the list of group filter items. The ID can be used in the type parameter to /groups.

The parent_id attribute represents the parent filter item, if a child item.

Example Request: GET http://CALENDAR-URL/api/2/groups/filters

{
}

Labels

Resource: GET /groups/labels

Returns the display labels for filter types and custom fields. The key is the identifier (as used in other responses) and value is the user-friendly label.

Example Request: GET http://CALENDAR-URL/api/2/groups/labels

{
  "custom_fields": {
  },
  "filters": {
    "group_types": "Group Types"
  }
}

Department Groups

Provides access to department groups. This resource functions just like groups.

See the groups API for usage details.

Note: Advanced department functionality must be enabled (departments must have their own page) for these APIs to function.

Format

{
  "department": {
    "id": 911,
    "name": "African Studies Program",
    "urlname": "african_studies_program",
    "created_at": "2011-03-07T21:08:35Z",
    "updated_at": "2011-03-07T21:08:35Z",
    "photo_id": null,
    "school_id": 1,
    "campus_id": 11,
    "url": null,
    "description_text": "",
    "description": "",
    "filters": {
    },
    "custom_fields": {
    },
    "localist_url": "http://events.jhu.edu/department/african_studies_program",
    "photo_url": "http://images-cf.localist.com/images/main/business_huge.png?..."
  }
}

See the group format for attribute details.

List

Resource: GET /departments

The result hash includes an array of department group objects in the departments key, and a page key with paging information.

See /groups for details.

Get

Resource: GET /departments/DEPARTMENT_ID

See /groups/GROUP_ID for details.

Filters

Resource: GET /departments/filters

See /groups/filters for details.

Labels

Resource: GET /departments/labels

See /groups/labels for details.

Photos

This resource provides access to photo metadata.

Format

{
  "photo": {
    "id": 60781,
    "business_id": null,
    "caption": "New Mosaic",
    "event_instance_id": null,
    "user_id": 0,
    "neighborhood_id": null,
    "created_at": "2013-04-05T13:59:24-04:00",
    "updated_at": "2013-04-05T13:59:24-04:00",
    "location": null,
    "plan_id": null,
    "group_id": null,
    "image_file_name": "4tlRZYDEoGkaf4NI.jpg",
    "image_content_type": "image/jpeg",
    "image_updated_at": "2013-04-05T13:59:24-04:00",
    "credit": null,
    "width": 576,
    "height": 384,
    "localist_url": "http://events.wtmd.org/photo/60781",
    "photo_url": "http://images-cf.localist.com/photos/60781/huge/a69941856ab8..."
  }
}