{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Locations API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Locations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/locations",
            "params": [
              {
                "name": "name",
                "value": "Denver",
                "type": "query",
                "description": "List locations whose name contains this string (case-insensitive)."
              },
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
                "type": "query",
                "description": "List locations by ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "List locations in this organization. Only admin users of another organization (such as partners) may use this parameter."
              },
              {
                "name": "max",
                "value": "100",
                "type": "query",
                "description": "Limit the maximum number of location in the response."
              }
            ]
          },
          "docs": "List locations for an organization.\n\n* Use query parameters to filter the result set by location name, ID, or organization.\n\n* Long result sets will be split into [pages](/docs/basics#pagination).\n\n* Searching and viewing locations in your organization requires an administrator or location administrator auth token with any of the following scopes: `spark-admin:locations_read`, `spark-admin:people_read` or `spark-admin:device_read`."
        },
        {
          "info": {
            "name": "Create a Location",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/locations",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Create a location common attribute for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Location for a given organization. Only an admin in the organization can create a new Location.\n\n* Creating a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Partners may specify `orgId` query parameter to create location in managed organization.\n\n* The following body parameters are required to create a new location: \n    * `name`\n    * `timeZone`\n    * `preferredLanguage`\n    * `address`\n    * `announcementLan"
        },
        {
          "info": {
            "name": "Get Location Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/locations/:locationId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
                "type": "path",
                "description": "A unique identifier for the location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Get location common attributes for this organization."
              }
            ]
          },
          "docs": "Shows details for a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Use query parameter `orgId` to filter the result set by organization(optional).\n\n* Searching and viewing location in your organization requires an administrator or location administrator auth token with any of the following scopes:\n\n    * `spark-admin:locations_read`\n    * `spark-admin:people_read`\n    * `spark-admin:device_read`"
        },
        {
          "info": {
            "name": "Update a Location",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/locations/:locationId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
                "type": "path",
                "description": "Update location common attributes for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Update location common attributes for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update details for a location, by ID.\n\n* Updating a location in your organization requires a full administrator or location administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Partners may specify `orgId` query parameter to update location in managed organization.\n\n* **Important:** While the `name` field supports up to 256 characters, locations that are enabled for Webex Calling must have names with a max"
        },
        {
          "info": {
            "name": "Delete Location",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/locations/:locationId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
                "type": "path",
                "description": "A unique identifier for the location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Specify the organization for the location to be deleted."
              }
            ]
          },
          "docs": "Delete a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Deleting a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* NOTE: Disabling Webex Calling for a Webex Calling enabled location is required prior to deleting a location."
        },
        {
          "info": {
            "name": "List Location Floors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/locations/:locationId/floors",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
                "type": "path",
                "description": "A unique identifier for the location."
              }
            ]
          },
          "docs": "List location floors.\nRequires an administrator auth token with the `spark-admin:locations_read` scope."
        },
        {
          "info": {
            "name": "Create a Location Floor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/locations/:locationId/floors",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
                "type": "path",
                "description": "A unique identifier for the location."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new floor in the given location. The `displayName` parameter is optional, and omitting it will result in the creation of a floor without that value set.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
        },
        {
          "info": {
            "name": "Get Location Floor Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
                "type": "path",
                "description": "A unique identifier for the location."
              },
              {
                "name": "floorId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
                "type": "path",
                "description": "A unique identifier for the floor."
              }
            ]
          },
          "docs": "Shows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:locations_read` scope."
        },
        {
          "info": {
            "name": "Update a Location Floor",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
                "type": "path",
                "description": "A unique identifier for the location."
              },
              {
                "name": "floorId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
                "type": "path",
                "description": "A unique identifier for the floor."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI. Include all details for the floor returned by a previous call to [Get Location Floor Details](/docs/api/v1/locations/get-location-floor-details). Omitting the optional `displayName` field will result in that field no longer being defined for the floor.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
        },
        {
          "info": {
            "name": "Delete a Location Floor",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
                "type": "path",
                "description": "A unique identifier for the location."
              },
              {
                "name": "floorId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
                "type": "path",
                "description": "A unique identifier for the floor."
              }
            ]
          },
          "docs": "Deletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
        }
      ]
    }
  ],
  "bundled": true
}