Preview deleting locations

Reports what bulk deleting the selected locations would do to the records that hold them as a campus; nothing is written. The query filters and the body select the locations exactly as they do for deleting. Each entry in types counts one kind of record: sole is the records naming nothing but the selected locations, which would lose their last campus, and shared is the records that keep something outside the selection: another campus, or, for a user's or role's campus limit (while multi-org is on) or a form access rule, dashboard sharing rule or chat access criterion, an organization, and for such a rule also a group, saved query, record type or person. People count through their campuses. The users, roles and facilityRequests entries count the users and roles whose campus limit holds a selected location and the facility requests raised for one. The formAccessRules, dashboardAccessRules and savedQueries entries count the form access rules, dashboard sharing rules and saved query filter statements that name a selected location. The overrides, routingRules and chatAccessRules entries count the users and roles with campus permission overrides at a selected location and the form routing rules and chat access criteria that name one. The steps field is the number of workflow set-campus steps naming the locations that the delete will clear, branches the workflow campus condition branches it will remove, and overrides the users and roles whose campus permission overrides sit only at the selected locations (removed by the delete). The blocked field names each location whose rooms or items have bookings, events, check-in rooms or check-in history; the delete is refused while it is not empty. The targetRequired field also turns on when a user or role would be left with a limit that holds only the selected locations or a facility request was raised for one or a form access rule, dashboard sharing rule, saved query filter, form routing rule or chat access criterion names only the selected locations, or a user or role has campus permission overrides only at them; the delete then needs target=everyone. While multi-campus is on and multi-org is off, the limitsRefused field is true when a role, or a user their own campus limit binds, has a campus limit only at the selected locations, and onlyHereUsers and onlyHereRoles name them: the delete is refused for every caller until each of them has another campus in their limit. While multi-org is on, the churchWideRefused field is true when you are campus- or organization-limited and an organization such a limit becomes reaches past you, so the delete refuses target=everyone. The campusAttendedPeople field counts the people who belong to their whole organization and list one of the selected locations as their attended campus, whom the people entry does not count: the delete clears their attended campus and leaves them in their organization. An empty include selection is rejected as it is for the delete. While multi-campus is on, a campus-limited caller never selects a location outside their campuses, and, while multi-org is on, an organization-limited caller never selects a location outside their reach.

Required permission: Locations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Returns locations where the name contains the given search terms.

string

Returns locations where the description contains the given text.

string

Comma-delimited list of type ids. Use -1 to include locations without a type. Values come from /api/property_values/location_types/values.

boolean

Whether the location is active or not. If not provided, returns locations regardless of status.

int32

An event id, to list the locations the caller may book for that event. While multi-campus is on, a caller who administers the event (its organizer, an administrator of its group, or events write at its campuses) also gets the event's campuses and every venue (a location that is not a campus), or every location for an event with no campuses and no organization. While multi-org is on the venues are those of the event's organizations and of the organizations the caller reaches, and an event with no campuses and no organization opens a limited caller only the locations of the organizations they reach. Ignored with approvers or export, and by deletes and delete previews. An unknown event, or one the caller does not administer, is ignored.

string

Organization ids, comma-separated; honoured only while multi-org is on. Returns the locations that belong to one of them, and narrows a select-all delete and its preview the same way.

Body Params

The ids of the locations to preview

ids
array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids
boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json