[Index]
Model ref.: device/msteamsonline/CsOnlineLisLocation
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "City": { "name": "City", "type": "string", "title": "City", "readonly": true }, "CityAlias": { "name": "CityAlias", "type": "string", "title": "City Alias", "readonly": true }, "CivicAddressId": { "name": "CivicAddressId", "type": "string", "title": "Civic Address ID", "description": "Specifies the unique identifier of the civic address that contains the location.", "readonly": true }, "CompanyName": { "name": "CompanyName", "type": "string", "title": "Company Name", "readonly": true }, "CompanyTaxId": { "name": "CompanyTaxId", "type": "string", "title": "Company Tax ID", "readonly": true }, "Confidence": { "name": "Confidence", "type": "string", "title": "Confidence", "readonly": true }, "CountryOrRegion": { "name": "CountryOrRegion", "type": "string", "title": "Country Or Region", "readonly": true }, "CountyOrDistrict": { "name": "CountyOrDistrict", "type": "string", "title": "County Or District", "readonly": true }, "Elin": { "name": "Elin", "type": "string", "title": "ELIN", "description": "Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios." }, "HouseNumber": { "name": "HouseNumber", "type": "string", "title": "House Number", "readonly": true }, "HouseNumberSuffix": { "name": "HouseNumberSuffix", "type": "string", "title": "House Number Suffix", "readonly": true }, "IsDefault": { "name": "IsDefault", "type": "boolean", "title": "Is Default", "readonly": true }, "Latitude": { "name": "Latitude", "type": "string", "title": "Latitude", "readonly": true }, "Location": { "name": "Location", "type": "string", "title": "Location", "description": "Specifies an administrator defined description of the location. For example, \"2nd Floor Cafe\", \"Main Lobby\", or \"Office 250\"." }, "LocationId": { "name": "LocationId", "type": "string", "title": "Location ID", "readonly": true }, "Longitude": { "name": "Longitude", "type": "string", "title": "Longitude", "readonly": true }, "NumberOfTelephoneNumbers": { "name": "NumberOfTelephoneNumbers", "type": "integer", "title": "Number Of Telephone Numbers", "readonly": true }, "NumberOfVoiceUsers": { "name": "NumberOfVoiceUsers", "type": "integer", "title": "Number Of Voice Users", "readonly": true }, "PartnerId": { "name": "PartnerId", "type": "string", "title": "Partner ID", "readonly": true }, "PostDirectional": { "name": "PostDirectional", "type": "string", "title": "Post Directional", "readonly": true }, "PostalCode": { "name": "PostalCode", "type": "string", "title": "Postal Code", "readonly": true }, "PreDirectional": { "name": "PreDirectional", "type": "string", "title": "Pre Directional", "readonly": true }, "StateOrProvince": { "name": "StateOrProvince", "type": "string", "title": "State Or Province", "readonly": true }, "StreetName": { "name": "StreetName", "type": "string", "title": "Street Name", "readonly": true }, "StreetSuffix": { "name": "StreetSuffix", "type": "string", "title": "Street Suffix", "readonly": true }, "TenantId": { "name": "TenantId", "type": "string", "title": "Tenant ID", "readonly": true }, "ValidationStatus": { "name": "ValidationStatus", "type": "string", "title": "Validation Status", "readonly": true, "description": "Validated addresses cannot be changed, the address must be removed and added again." } }, "schema_version": "2019.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/msteamsonline/CsOnlineLisLocation/add/ |
|
The GUI Add form of device/msteamsonline/CsOnlineLisLocation as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/msteamsonline/CsOnlineLisLocation | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/msteamsonline/CsOnlineLisLocation/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/msteamsonline/CsOnlineLisLocation/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/msteamsonline/CsOnlineLisLocation/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/v0/device/msteamsonline/CsOnlineLisLocation/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlineLisLocation |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineLisLocation/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlineLisLocation |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsOnlineLisLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsOnlineLisLocation/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[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/msteamsonline/CsOnlineLisLocation and the JSON format can be used to import instances of device/msteamsonline/CsOnlineLisLocation.
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsOnlineLisLocation | POST | /api/device/msteamsonline/CsOnlineLisLocation/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/device/msteamsonline/CsOnlineLisLocation/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/device/msteamsonline/CsOnlineLisLocation/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/msteamsonline/CsOnlineLisLocation/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/msteamsonline/CsOnlineLisLocation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/device/msteamsonline/CsOnlineLisLocation/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/msteamsonline/CsOnlineLisLocation/ |
|
The device/msteamsonline/CsOnlineLisLocation schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsOnlineLisLocation instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "Location", "direction": "asc", "current": "/api/device/msteamsonline/CsOnlineLisLocation/?skip=0&limit=3&order_by=Location&direction=asc&traversal=down" }, "operations": [ "list", "add" ], "meta": { "model_type": "device/msteamsonline/CsOnlineLisLocation", "summary_attrs": [ { "name": "Location", "title": "Location" }, { "name": "CompanyName", "title": "Company Name" }, { "name": "City", "title": "City" }, { "name": "CountryOrRegion", "title": "Country Or Region" }, { "name": "Elin", "title": "ELIN" }, { "name": "IsDefault", "title": "Is Default" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "list", "add", "get", "update", "remove", "move", "clone", "export", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "help", "migration", "transform", "tag", "tag_version" ], "schema_version": "2019.1", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/device/msteamsonline/CsOnlineLisLocation/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/device/msteamsonline/CsOnlineLisLocation/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlineLisLocation", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "method": "POST", "class": "export", "href": "/api/device/msteamsonline/CsOnlineLisLocation/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/device/msteamsonline/CsOnlineLisLocation/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/device/msteamsonline/CsOnlineLisLocation/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/device/msteamsonline/CsOnlineLisLocation/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/device/msteamsonline/CsOnlineLisLocation/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/device/msteamsonline/CsOnlineLisLocation/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/device/msteamsonline/CsOnlineLisLocation/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/msteamsonline/CsOnlineLisLocation/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/msteamsonline/CsOnlineLisLocation/purge/?hierarchy=[hierarchy]", "support_async": false, "title": "Purge" } }, { "transform": { "method": "GET", "class": "transform", "href": "/api/device/msteamsonline/CsOnlineLisLocation/transform/?hierarchy=[hierarchy]", "support_async": false, "title": "Transform Template" } } ] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/msteamsonline/CsOnlineLisLocation. | GET | /api/device/msteamsonline/CsOnlineLisLocation/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsOnlineLisLocation as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Purge | POST | /api/device/msteamsonline/CsOnlineLisLocation/purge/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Transform Template | GET | /api/device/msteamsonline/CsOnlineLisLocation/transform/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/msteamsonline/CsOnlineLisLocation/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/msteamsonline/CsOnlineLisLocation/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsOnlineLisLocation | 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/msteamsonline/CsOnlineLisLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/export |
|
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/msteamsonline/CsOnlineLisLocation and the JSON format can be used to import instances of device/msteamsonline/CsOnlineLisLocation.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsOnlineLisLocation instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsOnlineLisLocation. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |