[Index]
Model ref.: relation/EmergencyLocationNetwork
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": {
"Identity": {
"name": "Identity",
"type": "string",
"title": "Site Name",
"required": true
},
"Description": {
"name": "Description",
"type": [
"string",
"null"
],
"title": "Description"
},
"NetworkRegionID": {
"name": "NetworkRegionID",
"description": "NetworkRegionID is the identifier for the network region which the current network site is associating to.",
"type": "string",
"title": "Network Region",
"format": "uri",
"target": "/api/device/msteamsonline/CsTenantNetworkRegion/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTenantNetworkRegion",
"choices": []
},
"EnableLocationBasedRouting": {
"name": "EnableLocationBasedRouting",
"description": "This parameter determines whether the current site is enabled for location based routing.",
"type": "boolean",
"title": "Enable Location Based Routing"
},
"EmergencyCallRoutingPolicy": {
"name": "EmergencyCallRoutingPolicy",
"description": "This parameter is used to assign a custom emergency call routing policy to a network site.",
"type": "string",
"title": "Emergency Call Routing Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy",
"choices": []
},
"EmergencyCallingPolicy": {
"name": "EmergencyCallingPolicy",
"description": "This parameter is used to assign a custom emergency calling policy to a network site.",
"type": "string",
"title": "Emergency Calling Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallingPolicy",
"choices": []
},
"NetworkRoamingPolicy": {
"name": "NetworkRoamingPolicy",
"description": "NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to.",
"type": [
"string",
"null"
],
"title": "Network Roaming Policy"
},
"subnets": {
"title": "Subnets",
"type": "array",
"items": {
"type": "object",
"properties": {
"NetworkSiteID": {
"name": "NetworkSiteID",
"type": "string",
"title": "Network Site",
"description": "NetworkSiteID is the identifier for the network site which the current network subnet is associating to.",
"required": true,
"format": "uri",
"target": "/api/device/msteamsonline/CsTenantNetworkSite/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTenantNetworkSite",
"choices": []
},
"Identity": {
"name": "Identity",
"type": "string",
"title": "IP Address",
"description": "The name of the network subnet. This must be a unique and valid IPv4 or IPv6 address.",
"required": true,
"readonly": true,
"pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))"
},
"MaskBits": {
"name": "MaskBits",
"type": "integer",
"title": "Mask",
"description": "IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive.",
"required": true,
"minimum": 0,
"maximum": 128
},
"Description": {
"name": "Description",
"type": [
"string",
"null"
],
"title": "Description"
}
}
}
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/EmergencyLocationNetwork; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/EmergencyLocationNetwork/export/ |
|
{ "hrefs":["/api/relation/EmergencyLocationNetwork/[pkid1]", "/api/relation/EmergencyLocationNetwork/[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 relation/EmergencyLocationNetwork and the JSON format can be used to import instances of relation/EmergencyLocationNetwork.
GET http://[host-proxy]/api/relation/EmergencyLocationNetwork/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/EmergencyLocationNetwork/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/EmergencyLocationNetwork/ |
|
The relation/EmergencyLocationNetwork schema and all instances as JSON. |
(The list will return 0 to 3 relation/EmergencyLocationNetwork instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Identity",
"direction": "asc",
"current": "/api/relation/EmergencyLocationNetwork/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/EmergencyLocationNetwork",
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"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": [],
"self": [
{
"href": "/api/relation/EmergencyLocationNetwork/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"field_display_policy",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "1.1",
"actions": [
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/EmergencyLocationNetwork/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/EmergencyLocationNetwork/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/EmergencyLocationNetwork/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/EmergencyLocationNetwork/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/EmergencyLocationNetwork. | GET | /api/relation/EmergencyLocationNetwork/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/EmergencyLocationNetwork as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/EmergencyLocationNetwork; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/EmergencyLocationNetwork/[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 relation/EmergencyLocationNetwork and the JSON format can be used to import instances of relation/EmergencyLocationNetwork.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/EmergencyLocationNetwork/[pkid] | hierarchy=[hierarchy] | The relation/EmergencyLocationNetwork instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/EmergencyLocationNetwork/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/EmergencyLocationNetwork. |