Groups

API endpoints related to Beckman Institute groups and their members.

APIDescription
GET api/v{version}/groups

Get a list of all Beckman Institute groups.

GET api/v{version}/groups/{groupAbbv}?photos={photos}

Get the members of a specific Beckman Institute group.

GET api/v{version}/groups/contactinfo/{groupAbbv}

Get the contact information of a specific Beckman Institute group.

GET api/v{version}/groups/name/{groupName}?photos={photos}

Get the members of a specific Beckman Institute group by name of the group.

GET api/v{version}/groups/children/{groupAbbv}

Get the child groups of a specific Beckman Institute group.

BeckmanPwa

Beckman Institute API v2 endpoints for online cafe transactions.

APIDescription
GET api/v{version}/pwa/prerelease/verify?code={code}

No documentation available.

Directory

Beckman Institute API v2 endpoints for personnel queries.

APIDescription
GET api/v{version}/directory?photos={photos}

Get a list of current Beckman Institute personnel.

GET api/v{version}/directory/lastname/{firstLetter}?photos={photos}

Get a list of current Beckman Institute personnel whose last name starts with a given letter.

GET api/v{version}/directory/search/{query}?photos={photos}

Get a list of current Beckman Institute personnel who match a given query.

GET api/v{version}/directory/homeunits

Get a list of current Beckman Institute home units.

POST api/v{version}/directory/search/advanced

Get a list of current Beckman Institute personnel who match a given query.

GET api/v{version}/directory/{netId}?components[0]={components[0]}&components[1]={components[1]}

Select a personnel record by NetID, specifying which record components to return. If no options are specified, all record components will be returned.

GET api/v{version}/directory/recordcomponents

List available directory components.

GET api/v{version}/directory/{netId}/groups

Return the groups a staff member is a member of.

POST api/v{version}/directory/entry/add

Add a directory entry to the Beckman Directory (Authentication Required)

GET api/v{version}/directory/entries/{netid}

No documentation available.

POST api/v{version}/directory/entry/update

Update a directory entry to the Beckman Directory (Authentication Required)

POST api/v{version}/directory/entry/delete/{netid}

Delete a directory entry from the Beckman Directory (Authentication Required)

POST api/v{version}/directory/entry/link/add

Add bio links to the provided netid (Authentication Required)

POST api/v{version}/directory/entry/link/update

Updated bio links for the provided netid (Authentication Required)

POST api/v{version}/directory/entry/link/delete/{id}

Delete bio link for the provided id (Authentication Required)

POST api/v{version}/directory/entry/publication/add

Add publication to the provided netid (Authentication Required)

POST api/v{version}/directory/entry/publication/update

Update publication to the provided entry (Authentication Required)

POST api/v{version}/directory/entry/publication/delete/{id}

Delete publication from the provided id (Authentication Required)

POST api/v{version}/directory/entry/photo/upload/{netid}

No documentation available.

GET api/v{version}/directory/group

No documentation available.

POST api/v{version}/directory/group/add

No documentation available.

POST api/v{version}/directory/group/update

No documentation available.

Feeds

Beckman API v1.

APIDescription
GET api/v{version}/feeds

Empty API query.

GET api/v{version}/feeds/directory

Get a list of current Beckman personnel in short record format.

GET api/v{version}/feeds/cafemenus?style={style}&css={css}

Generates and formats a feed of current Beckman Cafe menus.

GET api/v{version}/feeds/events?days={days}&calendar={calendar}

Get a list of scheduled events hosted at or sponsored by the Beckman Institute.

GET api/v{version}/feeds/news?days={days}

Get a list of recent Beckman news articles.

GET api/v{version}/feeds/listeners

Get a list of public listeners (e.g., SignalR hubs).

PUT api/v{version}/feeds/listeners/update/{id}

Activates an update on all relevant websocket listeners.

Listeners

Beckman Institute API v2 endpoints for websocket queries.

APIDescription
GET api/v{version}/listeners

Get a list of public listeners (e.g., SignalR hubs).

PUT api/v{version}/listeners/update/{id}

Activates an update on all relevant websocket listeners.

Newsletter

Beckman Institute API v2 endpoints for newsletter queries.

APIDescription
GET api/v{version}/newsletter/role/{name}

Get a role by name for calendar lookup.

GET api/v{version}/newsletter/calendars/role/{Id}

Get a calendar list by id of role.

POST api/v{version}/newsletter/calendars/role/add

Add a calendar providing role Id, calendar Id, Name.

DELETE api/v{version}/newsletter/calendars/role/remove/{id}

No documentation available.

GET api/v{version}/newsletter/campaign/role/{Id}

Get campaign by the Id of the role.

Events

API endpoints for Beckman Institute events.

APIDescription
GET api/v{version}/events?days={days}&calendar={calendar}

Get upcoming Beckman events.

GET api/v{version}/events/dates?from={from}&to={to}&calendar={calendar}

Get Beckman events within the specified date range.

GET api/v{version}/events/id?eventIds[0]={eventIds[0]}&eventIds[1]={eventIds[1]}&calendar={calendar}

Request one or more events by EventId.

GET api/v{version}/events/recurring?calendar={calendar}

List recurring events.

GET api/v{version}/events/recurring/{id}?calendar={calendar}

List recurring events.

GET api/v{version}/events/calendars

List available event calendars.

GET api/v{version}/events/tags?calendar={calendar}

List tags currently in use.

Cafe

Beckman Institute API v2 endpoints for Cafe queries.

APIDescription
GET api/v{version}/cafe/menus?from={from}&to={to}&limit={limit}

Get a list of all menus.

GET api/v{version}/cafe/menus/{from}/dish/{id}

Get a dish from a menu.

GET api/v{version}/cafe/announcements?from={from}&to={to}&limit={limit}

Get a list of all cafe announcements.