API Reference for device/skypeforbusiness/CsLocationPolicy

Model ref.: device/skypeforbusiness/CsLocationPolicy

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "EnhancedEmergencyServiceDisclaimer": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. To remove a service disclaimer from a location policy set this property to a null value:\n-EnhancedEmergencyServiceDisclaimer $Null\nLocation policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server 2015 to set disclaimers for the E9-1-1 service. By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users.", 
               "title": "EnhancedEmergencyServiceDisclaimer", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "EnhancedEmergencyServiceDisclaimer"
          }, 
          "LocationRefreshInterval": {
               "__type_requested": "Int64", 
               "required": false, 
               "description": "Specifies the amount of time (in hours) between client requests for Location Information service location update. The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4.", 
               "title": "LocationRefreshInterval", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "LocationRefreshInterval"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A detailed description of this location. For example, \"Reno corporate users\".", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "EnhancedEmergencyServicesEnabled": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Specifies whether the users associated with this policy are enabled for E9-1-1. Set the value to True to enable E9-1-1 so Skype for Business Server 2015 clients will retrieve location information on registration and include that information when an emergency call is made.\nDefault Value: False", 
               "title": "EnhancedEmergencyServicesEnabled", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnhancedEmergencyServicesEnabled"
          }, 
          "PstnUsage": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route emergency calls from clients using this profile. The route associated with this usage should point to a SIP trunk dedicated to emergency calls.\nThe usage must already exist in the global list of PSTN usages. Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. To create a new usage, call the Set-CsPstnUsage cmdlet.", 
               "title": "PstnUsage", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "PstnUsage"
          }, 
          "ScopeClass": {
               "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", 
               "required": false, 
               "name": "ScopeClass", 
               "title": "ScopeClass", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Element": {
               "__type_requested": "System.Xml.Linq.XElement", 
               "required": false, 
               "name": "Element", 
               "title": "Element", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "InMemory": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", 
               "title": "InMemory", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "InMemory"
          }, 
          "UseLocationForE911Only": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Location information can be used by the Skype for Business Server 2015 client for various reasons (such as notifying teammates of current location). Set this value to True to ensure location information is available only for use with an emergency call.", 
               "title": "UseLocationForE911Only", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UseLocationForE911Only"
          }, 
          "NotificationUri": {
               "__type_requested": "String", 
               "required": false, 
               "description": "One or more SIP URIs to be notified when an emergency call is made. For example, the company security office could be notified through an instant message whenever an emergency call is made. If the caller's location is available that location will be included in the notification.\nMultiple SIP URIs can be included as a comma-separated list. For example, -NotificationUri sip:[email protected],sip:[email protected]. Note that distribution lists can be configured as a notification URI.\nThe string must be from 1 to 256 characters in length and must begin with the prefix sip:.", 
               "title": "NotificationUri", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "NotificationUri"
          }, 
          "EmergencyDialMask": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of \"212\" and EmergencyDialString has a value of \"911\", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region's number rather than the number for the country/region they're currently in). You can define multiple emergency dial masks by separating the values with semicolons. For example, -EmergencyDialMask \"212;414\".\nIMPORTANT. Ensure that the specified dial mask value is not the same as a number in a call park orbit range. Call park routing will take precedence over emergency dial string conversion. To see the existing call park orbit ranges, call the Get-CsCallParkOrbit cmdlet.\nMaximum length of the string is 100 characters. Each character must be a digit 0 through 9.", 
               "title": "EmergencyDialMask", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "EmergencyDialMask"
          }, 
          "Tenant": {
               "__type_requested": "Guid", 
               "required": false, 
               "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new location policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your Skype for Business Online tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", 
               "title": "Tenant", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Tenant"
          }, 
          "LocationRequired": {
               "__type_requested": "System.Nullable[Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationRequiredEnum]", 
               "required": false, 
               "description": "If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. This parameter accepts the following values:\n- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location.\n- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP operator (the 911 operator).\n- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.)\nThis value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). Users will not be prompted for location information.", 
               "title": "LocationRequired", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "LocationRequired"
          }, 
          "ConferenceMode": {
               "__type_requested": "System.Nullable[Microsoft.Rtc.Management.WritableConfig.Policy.Location.ConferenceModeEnum]", 
               "required": false, 
               "description": "If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are:\nOneway: Third party can only listen to the conversation between the caller and the Public Safety Answering Point (PSAP) operator.\nTwoway: Third party can listen in and participate in the call between the caller and the PSAP operator.", 
               "title": "ConferenceMode", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "ConferenceMode"
          }, 
          "EmergencyDialString": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The number that is dialed to reach emergency services. In the United States this value is 911.\nThe string must be made of the digits 0 through 9 and can be from 1 to 10 digits in length.", 
               "title": "EmergencyDialString", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "EmergencyDialString"
          }, 
          "ConferenceUri": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property).\nThe string must be from 1 to 256 characters in length and must begin with the prefix sip:.", 
               "title": "ConferenceUri", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ConferenceUri"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "A unique identifier for the location policy. This cmdlet can be used to create policies at the site or per-user scope. (A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must be in the form site:<site name>, where site name is the name of a site defined in the Skype for Business Server 2015 deployment. For example, site:Redmond. A policy created at the per-user scope can be assigned any string value, such as Reno.", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "Anchor": {
               "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", 
               "required": false, 
               "name": "Anchor", 
               "title": "Anchor", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusiness/CsLocationPolicy/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/skypeforbusiness/CsLocationPolicy device/skypeforbusiness/CsLocationPolicy schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusiness/CsLocationPolicy/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsLocationPolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsLocationPolicy/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/skypeforbusiness/CsLocationPolicy	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsLocationPolicy/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusiness/CsLocationPolicy	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsLocationPolicy/[pkid1]", "/api/device/skypeforbusiness/CsLocationPolicy/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsLocationPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusiness/CsLocationPolicy/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusiness/CsLocationPolicy/[pkid1]", "/api/device/skypeforbusiness/CsLocationPolicy/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of device/skypeforbusiness/CsLocationPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsLocationPolicy.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/skypeforbusiness/CsLocationPolicy:

 GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsLocationPolicy	POST	/api/device/skypeforbusiness/CsLocationPolicy/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/skypeforbusiness/CsLocationPolicy	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusiness/CsLocationPolicy/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/skypeforbusiness/CsLocationPolicy/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/skypeforbusiness/CsLocationPolicy/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusiness/CsLocationPolicy schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusiness/CsLocationPolicy instances)

GET http://[host]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "cs_location_policy", 
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Identity", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusiness/CsLocationPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "1150", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/skypeforbusiness/CsLocationPolicy", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "cs_location_policy": {
                         "support_async": true, 
                         "class": "custom", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/+cs_location_policy/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Cs Location Policy"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusiness/CsLocationPolicy/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusiness/CsLocationPolicy", 
          "model_specific_actions": [
               "list", 
               "get", 
               "cs_location_policy", 
               "powershell_disable", 
               "powershell_enable", 
               "powershell_move", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Identity", 
                    "title": "Identity"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/skypeforbusiness/CsLocationPolicy.	GET	/api/device/skypeforbusiness/CsLocationPolicy/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusiness/CsLocationPolicy as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/skypeforbusiness/CsLocationPolicy

GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsLocationPolicy	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/skypeforbusiness/CsLocationPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of device/skypeforbusiness/CsLocationPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsLocationPolicy.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusiness/CsLocationPolicy instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/skypeforbusiness/CsLocationPolicy.

Task	Call	URL	Parameters	Payload
Powershell Disable	POST	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/+powershell_disable/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Powershell Enable	POST	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/+powershell_enable/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Powershell Move	POST	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/+powershell_move/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/skypeforbusiness/CsLocationPolicy/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/skypeforbusiness/CsLocationPolicy

GET http://[host-proxy]/api/device/skypeforbusiness/CsLocationPolicy/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/skypeforbusiness/CsLocationPolicy/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Powershell Disable

Powershell Enable

Powershell Move

Purge