Preview deleting a location

Reports what deleting the location would do to the records that hold it as a campus; nothing is written. 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 the location and the facility requests raised for it. The formAccessRules, dashboardAccessRules and savedQueries entries count the form access rules, dashboard sharing rules and saved query filter statements that name it. The overrides, routingRules and chatAccessRules entries count the users and roles with campus permission overrides there and the form routing rules and chat access criteria that name it. The steps field is the number of workflow set-campus steps naming the location 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 there (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 location or a facility request was raised for it or a form access rule, dashboard sharing rule, saved query filter, form routing rule or chat access criterion names only it, or a user or role has campus permission overrides only there; 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 location, and onlyHereUsers and onlyHereRoles name them: the delete is refused for every caller until each of them has another campus in their limit, or the campus is merged instead. While multi-org is on, a user or role whose limit also names an organization counts as shared, the limitOrganizations field names the organization the other limits become, churchWideRefused is true when you are campus- or organization-limited and that organization reaches past you, so the delete refuses target=everyone, and each lastOfOrganization entry lists the users whose limit becomes the organization (organizationLimitUsers) apart from the users who lose its records (users). The campusAttendedPeople field counts the people who belong to their whole organization and list the location as their attended campus, whom the people entry does not count: the delete clears their attended campus and leaves them in their organization. While multi-campus is on, a campus-limited caller gets a 404 HTTP response for a location outside their campuses, and, while multi-org is on, an organization-limited caller gets a 404 for a location outside their reach.

Required permission: Locations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the location to preview.

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