ILocationService1

Operations

NameSignatureDescription
BulkGetLocationDetailsLocationDetails1[] BulkGetLocationDetails(Uri[] locationUris)Retrieves a set of locations' details.
BulkGetLocationsLocationReference1[] BulkGetLocations(Uri[] locationUris)Bulk get locations from their URI. If a URI is not found, it will be omitted from the results.
BulkGetLocationsInPolicyDataAccessScopeLocationBulkGetResult1[] BulkGetLocationsInPolicyDataAccessScope(Uri[] locationUris, Uri policyUri)Retrieves a set of locations, filtered to those which are accessible in the given policy. Locations which are not accessible are not returned. Contextual ancestors are included in the result.
CreateEditDraftUri CreateEditDraft(Uri locationUri)Create a draft of an existing location.
CreateLocationDeleteBatchUri CreateLocationDeleteBatch(LocationTargetParameter2[] locations, Uri locationBulkDeleteOptionUri)Create a batch operation for bulk deleting locations by target
CreateLocationOrApplyModificationLocationReference1 CreateLocationOrApplyModification(LocationTargetParameter2 location, LocationModificationsParameter1 modifications, String unitOfWorkId)Operation CreateLocationOrApplyModification
CreateNewDraftUri CreateNewDraft(Uri parentLocationUri)Create a new location draft.
Deletevoid Delete(Uri locationUri)Delete a location. A location can only be deleted if it has no users assigned to it (past, present, or future).
Disablevoid Disable(Uri locationUri)Disables the location so it can no longer have any additional users assigned to it.
Enablevoid Enable(Uri locationUri)Enable the location so it can have additional users assigned to it.
GetAllLocationsLocationReference1[] GetAllLocations()Retrieves all locations.
GetEnabledLocationsLocationReference1[] GetEnabledLocations()Retrieves all enabled locations
GetLocationDeleteBatchResultsLocationDeleteBatchResults1 GetLocationDeleteBatchResults(Uri locationDeleteBatchUri)Retrieve results of a completed LocationDeleteBatch operation. Returns null if the batch has not completed.
GetLocationDetailsLocationDetails1 GetLocationDetails(Uri locationUri)Retrieves a single location's details.
GetLocationScheduleForUserLocationScheduleEntryDetails1[] GetLocationScheduleForUser(Uri userUri)Get the location assignment schedule for the specified user
GetLocationsSystemSettingsLocationSystemSettingsDetails1 GetLocationsSystemSettings()Gets all settings for the system-wide locations feature, including language settings for all supported languages.
GetLocationsSystemSettingsLanguageDetailsLocationSystemSettingsLanguageDetails1 GetLocationsSystemSettingsLanguageDetails()Retrieves the language settings for the current user's language.
GetPageOfAvailableLocationsByTextSearchLocationSearchResult1[] GetPageOfAvailableLocationsByTextSearch(Int32 page, Int32 pageSize, LocationTextSearchParameter1 textSearch)Searches for locations matching a given text search parameter which users can be assigned to
GetPageOfLocationsInPolicyDataAccessScopeLocationSearchResult1[] GetPageOfLocationsInPolicyDataAccessScope(Int32 pageIndex, Int32 pageSize, Uri policyUri, LocationSearchParameter1 locationSearch)Get a page of locations which are accessable for the given policy
MoveLocationvoid MoveLocation(LocationTargetParameter2 location, LocationTargetParameter2 target)Move Location group from its current location to the target location.
PublishDraftLocationReference1 PublishDraft(Uri draftUri)Publish the location draft into a persisted location.
PutLocationScheduleForUservoid PutLocationScheduleForUser(Uri userUri, LocationScheduleEntryParameter1[] scheduleEntries)Put the entire location assignment schedule for the specified user
PutLocationsSystemSettingsvoid PutLocationsSystemSettings(Boolean isEnabled, LocationSystemSettingsLanguageParameter1[] languageSettings)Puts all settings for the system-wide locations feature, any supported languages not specified will be reverted to their default settings.
UpdateCodevoid UpdateCode(Uri locationUri, String code)Modify the code of a location.
UpdateDescriptionvoid UpdateDescription(Uri locationUri, String description)Modify the description of a location.
UpdateNamevoid UpdateName(Uri locationUri, String name)Modify the name of a location.