[Index]
Model ref.: relation/EmergencyLocation
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",
"description": "Specifies a city for the civic address.",
"type": "string",
"title": "City"
},
"CityAlias": {
"name": "CityAlias",
"description": "Short form of the city name.",
"type": "string",
"title": "City Alias"
},
"CivicAddressId": {
"name": "CivicAddressId",
"description": "Specifies the unique identifier of the civic address",
"type": "string",
"title": "Civic Address ID",
"readonly": true
},
"CompanyName": {
"name": "CompanyName",
"description": "Specifies a company name for the civic address.",
"type": "string",
"title": "Company Name"
},
"CompanyTaxId": {
"name": "CompanyTaxId",
"description": "Used to store TaxId for regulatory reasons.",
"type": "string",
"title": "Company Tax ID"
},
"CountryOrRegion": {
"name": "CountryOrRegion",
"description": "Specifies the country or region of the civic address. Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification.",
"type": "string",
"title": "Country Or Region",
"choices": [
{
"value": "AF",
"title": "Afghanistan"
},
{
"value": "AX",
"title": "\u00c5land Islands"
},
{
"value": "AL",
"title": "Albania"
},
{
"value": "DZ",
"title": "Algeria"
},
{
"value": "AS",
"title": "American Samoa"
},
{
"value": "AD",
"title": "Andorra"
},
{
"value": "AO",
"title": "Angola"
},
{
"value": "AI",
"title": "Anguilla"
},
{
"value": "AQ",
"title": "Antarctica"
},
{
"value": "AG",
"title": "Antigua and Barbuda"
},
{
"value": "AR",
"title": "Argentina"
},
{
"value": "AM",
"title": "Armenia"
},
{
"value": "AW",
"title": "Aruba"
},
{
"value": "AU",
"title": "Australia"
},
{
"value": "AT",
"title": "Austria"
},
{
"value": "AZ",
"title": "Azerbaijan"
},
{
"value": "BS",
"title": "Bahamas, The"
},
{
"value": "BH",
"title": "Bahrain"
},
{
"value": "BD",
"title": "Bangladesh"
},
{
"value": "BB",
"title": "Barbados"
},
{
"value": "BY",
"title": "Belarus"
},
{
"value": "BE",
"title": "Belgium"
},
{
"value": "BZ",
"title": "Belize"
},
{
"value": "BJ",
"title": "Benin"
},
{
"value": "BM",
"title": "Bermuda"
},
{
"value": "BT",
"title": "Bhutan"
},
{
"value": "BT",
"title": "Bolivia"
},
{
"value": "BO",
"title": "Bonaire, Saint Eustatius and Saba"
},
{
"value": "BA",
"title": "Bosnia and Herzegovina"
},
{
"value": "BW",
"title": "Botswana"
},
{
"value": "BV",
"title": "Bouvet Island"
},
{
"value": "BR",
"title": "Brazil"
},
{
"value": "IO",
"title": "British Indian Ocean Territory"
},
{
"value": "IO",
"title": "Brunei"
},
{
"value": "BG",
"title": "Bulgaria"
},
{
"value": "BF",
"title": "Burkina Faso"
},
{
"value": "BI",
"title": "Burundi"
},
{
"value": "CV",
"title": "Cabo Verde"
},
{
"value": "KH",
"title": "Cambodia"
},
{
"value": "CM",
"title": "Cameroon"
},
{
"value": "CA",
"title": "Canada"
},
{
"value": "KY",
"title": "Cayman Islands"
},
{
"value": "CF",
"title": "Central African Republic"
},
{
"value": "TD",
"title": "Chad"
},
{
"value": "CL",
"title": "Chile"
},
{
"value": "CN",
"title": "China"
},
{
"value": "CX",
"title": "Christmas Island"
},
{
"value": "CC",
"title": "Cocos (Keeling) Islands"
},
{
"value": "CO",
"title": "Colombia"
},
{
"value": "KM",
"title": "Comoros"
},
{
"value": "CG",
"title": "Congo"
},
{
"value": "CG",
"title": "Congo (DRC)"
},
{
"value": "CK",
"title": "Cook Islands"
},
{
"value": "CR",
"title": "Costa Rica"
},
{
"value": "CR",
"title": "C\u00f4te d\u2019Ivoire"
},
{
"value": "HR",
"title": "Croatia"
},
{
"value": "CW",
"title": "Cura\u00e7ao"
},
{
"value": "CY",
"title": "Cyprus"
},
{
"value": "CY",
"title": "Czech Republic"
},
{
"value": "DK",
"title": "Denmark"
},
{
"value": "DJ",
"title": "Djibouti"
},
{
"value": "DM",
"title": "Dominica"
},
{
"value": "DO",
"title": "Dominican Republic"
},
{
"value": "EC",
"title": "Ecuador"
},
{
"value": "EG",
"title": "Egypt"
},
{
"value": "SV",
"title": "El Salvador"
},
{
"value": "GQ",
"title": "Equatorial Guinea"
},
{
"value": "ER",
"title": "Eritrea"
},
{
"value": "EE",
"title": "Estonia"
},
{
"value": "ET",
"title": "Ethiopia"
},
{
"value": "ET",
"title": "Falkland Islands (Islas Malvinas)"
},
{
"value": "FO",
"title": "Faroe Islands"
},
{
"value": "FJ",
"title": "Fiji Islands"
},
{
"value": "FI",
"title": "Finland"
},
{
"value": "FR",
"title": "France"
},
{
"value": "GF",
"title": "French Guiana"
},
{
"value": "PF",
"title": "French Polynesia"
},
{
"value": "PF",
"title": "French Southern and Antarctic Lands"
},
{
"value": "GA",
"title": "Gabon"
},
{
"value": "GM",
"title": "Gambia, The"
},
{
"value": "GE",
"title": "Georgia"
},
{
"value": "DE",
"title": "Germany"
},
{
"value": "GH",
"title": "Ghana"
},
{
"value": "GI",
"title": "Gibraltar"
},
{
"value": "GR",
"title": "Greece"
},
{
"value": "GL",
"title": "Greenland"
},
{
"value": "GD",
"title": "Grenada"
},
{
"value": "GP",
"title": "Guadeloupe"
},
{
"value": "GU",
"title": "Guam"
},
{
"value": "GT",
"title": "Guatemala"
},
{
"value": "GG",
"title": "Guernsey"
},
{
"value": "GN",
"title": "Guinea"
},
{
"value": "GW",
"title": "Guinea-Bissau"
},
{
"value": "GY",
"title": "Guyana"
},
{
"value": "HT",
"title": "Haiti"
},
{
"value": "HM",
"title": "Heard Island and McDonald Islands"
},
{
"value": "VA",
"title": "Holy See (Vatican City State)"
},
{
"value": "HN",
"title": "Honduras"
},
{
"value": "HK",
"title": "Hong Kong SAR"
},
{
"value": "HU",
"title": "Hungary"
},
{
"value": "IS",
"title": "Iceland"
},
{
"value": "IN",
"title": "India"
},
{
"value": "ID",
"title": "Indonesia"
},
{
"value": "IQ",
"title": "Iraq"
},
{
"value": "IE",
"title": "Ireland"
},
{
"value": "IM",
"title": "Isle of Man"
},
{
"value": "IL",
"title": "Israel"
},
{
"value": "IT",
"title": "Italy"
},
{
"value": "JM",
"title": "Jamaica"
},
{
"value": "JP",
"title": "Japan"
},
{
"value": "JE",
"title": "Jersey"
},
{
"value": "JO",
"title": "Jordan"
},
{
"value": "KZ",
"title": "Kazakhstan"
},
{
"value": "KE",
"title": "Kenya"
},
{
"value": "KI",
"title": "Kiribati"
},
{
"value": "KR",
"title": "Korea, Republic of"
},
{
"value": "KW",
"title": "Kuwait"
},
{
"value": "KG",
"title": "Kyrgyzstan"
},
{
"value": "LA",
"title": "Laos"
},
{
"value": "LV",
"title": "Latvia"
},
{
"value": "LB",
"title": "Lebanon"
},
{
"value": "LS",
"title": "Lesotho"
},
{
"value": "LR",
"title": "Liberia"
},
{
"value": "LY",
"title": "Libya"
},
{
"value": "LI",
"title": "Liechtenstein"
},
{
"value": "LT",
"title": "Lithuania"
},
{
"value": "LU",
"title": "Luxembourg"
},
{
"value": "MO",
"title": "Macao SAR"
},
{
"value": "MO",
"title": "Macedonia, Former Yugoslav Republic of"
},
{
"value": "MG",
"title": "Madagascar"
},
{
"value": "MW",
"title": "Malawi"
},
{
"value": "MY",
"title": "Malaysia"
},
{
"value": "MV",
"title": "Maldives"
},
{
"value": "ML",
"title": "Mali"
},
{
"value": "MT",
"title": "Malta"
},
{
"value": "MH",
"title": "Marshall Islands"
},
{
"value": "MQ",
"title": "Martinique"
},
{
"value": "MR",
"title": "Mauritania"
},
{
"value": "MU",
"title": "Mauritius"
},
{
"value": "YT",
"title": "Mayotte"
},
{
"value": "MX",
"title": "Mexico"
},
{
"value": "MX",
"title": "Micronesia"
},
{
"value": "FM",
"title": "Moldova"
},
{
"value": "MC",
"title": "Monaco"
},
{
"value": "MN",
"title": "Mongolia"
},
{
"value": "ME",
"title": "Montenegro"
},
{
"value": "MS",
"title": "Montserrat"
},
{
"value": "MA",
"title": "Morocco"
},
{
"value": "MZ",
"title": "Mozambique"
},
{
"value": "MM",
"title": "Myanmar"
},
{
"value": "NA",
"title": "Namibia"
},
{
"value": "NR",
"title": "Nauru"
},
{
"value": "NP",
"title": "Nepal"
},
{
"value": "NP",
"title": "Netherlands"
},
{
"value": "NP",
"title": "Netherlands Antilles (Former)"
},
{
"value": "NC",
"title": "New Caledonia"
},
{
"value": "NZ",
"title": "New Zealand"
},
{
"value": "NI",
"title": "Nicaragua"
},
{
"value": "NE",
"title": "Niger"
},
{
"value": "NG",
"title": "Nigeria"
},
{
"value": "NU",
"title": "Niue"
},
{
"value": "NF",
"title": "Norfolk Island"
},
{
"value": "MP",
"title": "Northern Mariana Islands"
},
{
"value": "NO",
"title": "Norway"
},
{
"value": "OM",
"title": "Oman"
},
{
"value": "PK",
"title": "Pakistan"
},
{
"value": "PW",
"title": "Palau"
},
{
"value": "PS",
"title": "Palestinian Authority"
},
{
"value": "PA",
"title": "Panama"
},
{
"value": "PG",
"title": "Papua New Guinea"
},
{
"value": "PY",
"title": "Paraguay"
},
{
"value": "PE",
"title": "Peru"
},
{
"value": "PH",
"title": "Philippines"
},
{
"value": "PN",
"title": "Pitcairn Islands"
},
{
"value": "PL",
"title": "Poland"
},
{
"value": "PT",
"title": "Portugal"
},
{
"value": "PR",
"title": "Puerto Rico"
},
{
"value": "QA",
"title": "Qatar"
},
{
"value": "QA",
"title": "Reunion"
},
{
"value": "RO",
"title": "Romania"
},
{
"value": "RO",
"title": "Russia"
},
{
"value": "RW",
"title": "Rwanda"
},
{
"value": "BL",
"title": "Saint Barth\u00e9lemy"
},
{
"value": "SH",
"title": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"value": "KN",
"title": "Saint Kitts and Nevis"
},
{
"value": "LC",
"title": "Saint Lucia"
},
{
"value": "LC",
"title": "Saint Martin"
},
{
"value": "PM",
"title": "Saint Pierre and Miquelon"
},
{
"value": "VC",
"title": "Saint Vincent and the Grenadines"
},
{
"value": "WS",
"title": "Samoa"
},
{
"value": "SM",
"title": "San Marino"
},
{
"value": "ST",
"title": "S\u00e3o Tom\u00e9 and Pr\u00edncipe"
},
{
"value": "SA",
"title": "Saudi Arabia"
},
{
"value": "SN",
"title": "Senegal"
},
{
"value": "RS",
"title": "Serbia"
},
{
"value": "SC",
"title": "Seychelles"
},
{
"value": "SL",
"title": "Sierra Leone"
},
{
"value": "SG",
"title": "Singapore"
},
{
"value": "SG",
"title": "Sint Maarten"
},
{
"value": "SK",
"title": "Slovakia"
},
{
"value": "SI",
"title": "Slovenia"
},
{
"value": "SB",
"title": "Solomon Islands"
},
{
"value": "SO",
"title": "Somalia"
},
{
"value": "ZA",
"title": "South Africa"
},
{
"value": "GS",
"title": "South Georgia and the South Sandwich Islands"
},
{
"value": "SS",
"title": "South Sudan"
},
{
"value": "ES",
"title": "Spain"
},
{
"value": "LK",
"title": "Sri Lanka"
},
{
"value": "SR",
"title": "Suriname"
},
{
"value": "SJ",
"title": "Svalbard and Jan Mayen Island"
},
{
"value": "SZ",
"title": "Swaziland"
},
{
"value": "SE",
"title": "Sweden"
},
{
"value": "CH",
"title": "Switzerland"
},
{
"value": "SY",
"title": "Taiwan"
},
{
"value": "TJ",
"title": "Tajikistan"
},
{
"value": "TJ",
"title": "Tanzania"
},
{
"value": "TH",
"title": "Thailand"
},
{
"value": "TL",
"title": "Timor-Leste"
},
{
"value": "TG",
"title": "Togo"
},
{
"value": "TK",
"title": "Tokelau"
},
{
"value": "TO",
"title": "Tonga"
},
{
"value": "TT",
"title": "Trinidad and Tobago"
},
{
"value": "TN",
"title": "Tunisia"
},
{
"value": "TR",
"title": "Turkey"
},
{
"value": "TM",
"title": "Turkmenistan"
},
{
"value": "TC",
"title": "Turks and Caicos Islands"
},
{
"value": "TV",
"title": "Tuvalu"
},
{
"value": "TV",
"title": "U.S. Minor Outlying Islands"
},
{
"value": "UG",
"title": "Uganda"
},
{
"value": "UA",
"title": "Ukraine"
},
{
"value": "AE",
"title": "United Arab Emirates"
},
{
"value": "GB",
"title": "United Kingdom"
},
{
"value": "US",
"title": "United States"
},
{
"value": "UY",
"title": "Uruguay"
},
{
"value": "UZ",
"title": "Uzbekistan"
},
{
"value": "VU",
"title": "Vanuatu"
},
{
"value": "VU",
"title": "Venezuela"
},
{
"value": "VN",
"title": "Vietnam"
},
{
"value": "VG",
"title": "Virgin Islands, British"
},
{
"value": "VI",
"title": "Virgin Islands, U.S."
},
{
"value": "WF",
"title": "Wallis and Futuna"
},
{
"value": "EH",
"title": "Western Sahara"
},
{
"value": "YE",
"title": "Yemen"
},
{
"value": "ZM",
"title": "Zambia"
},
{
"value": "ZW",
"title": "Zimbabwe"
}
]
},
"DefaultLocationId": {
"name": "DefaultLocationId",
"description": "Default location identifier",
"type": "string",
"title": "Default Location ID",
"readonly": true,
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineLisLocation/choices/?choice_title=Location&field=LocationId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "LocationId",
"target_title": "Location",
"target_model_type": "device/msteamsonline/CsOnlineLisLocation",
"choices": []
},
"Description": {
"name": "Description",
"description": "Description",
"type": "string",
"title": "Description"
},
"Elin": {
"name": "Elin",
"description": "Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios.",
"type": "string",
"title": "Default ELIN"
},
"HouseNumber": {
"name": "HouseNumber",
"description": "Specifies the numeric portion of the civic address.",
"type": "string",
"title": "House Number"
},
"HouseNumberSuffix": {
"name": "HouseNumberSuffix",
"description": "Specifies the numeric suffix of the new civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: \"425A Smith Avenue\", or \"425B Smith Avenue\".",
"type": "string",
"title": "House Number Suffix"
},
"Latitude": {
"name": "Latitude",
"description": "Specifies the angular distance of a place north or south of the earth's equator.",
"type": "string",
"title": "Latitude"
},
"Longitude": {
"name": "Longitude",
"description": "Specifies the angular distance of a place east or west of the meridian at Greenwich, England.",
"type": "string",
"title": "Longitude"
},
"NumberOfTelephoneNumbers": {
"name": "NumberOfTelephoneNumbers",
"description": "Number Of Telephone Numbers",
"type": "integer",
"title": "Number Of Telephone Numbers",
"readonly": true
},
"NumberOfVoiceUsers": {
"name": "NumberOfVoiceUsers",
"description": "Number Of Voice Users",
"type": "integer",
"title": "Number Of Voice Users",
"readonly": true
},
"PostalCode": {
"name": "PostalCode",
"description": "Specifies the postal code of the civic address.",
"type": "string",
"title": "Postal Code"
},
"PostDirectional": {
"name": "PostDirectional",
"description": "Specifies the directional attribute of the civic address which follows the street name. For example, \"425 Smith Avenue NE\".",
"type": "string",
"title": "Post Directional"
},
"PreDirectional": {
"name": "PreDirectional",
"description": "Specifies the directional attribute of the civic address which precedes the street name. For example, \"425 NE Smith Avenue\".",
"type": "string",
"title": "Pre Directional"
},
"StateOrProvince": {
"name": "StateOrProvince",
"description": "Specifies the state or province of the civic address.",
"type": "string",
"title": "State Or Province"
},
"StreetName": {
"name": "StreetName",
"description": "Specifies the street name of the civic address.",
"type": "string",
"title": "Street Name"
},
"StreetSuffix": {
"name": "StreetSuffix",
"description": "Specifies the modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard.",
"type": "string",
"title": "Street Suffix"
},
"ValidationStatus": {
"name": "ValidationStatus",
"description": "Validated addresses cannot be changed, the address must be removed and added again.",
"type": "string",
"title": "Validation Status",
"readonly": true
},
"locations": {
"title": "Locations",
"type": "array",
"items": {
"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."
},
"ports": {
"title": "Ports",
"type": "array",
"items": {
"type": "object",
"properties": {
"Description": {
"name": "Description",
"type": "string",
"title": "Description",
"description": "Specifies the administrator defined description of the Location Information Service subnet."
},
"LocationId": {
"name": "LocationId",
"type": "string",
"title": "Location ID",
"description": "Specifies the unique identifier of the location",
"readonly": true
},
"ChassisId": {
"name": "ChassisId",
"type": "string",
"title": "Chassis ID",
"description": "If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineLisSwitch/choices/?choice_title=ChassisId&field=ChassisId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "ChassisId",
"target_title": "ChassisId",
"target_model_type": "device/msteamsonline/CsOnlineLisSwitch",
"choices": []
},
"PortId": {
"name": "PortId",
"type": "string",
"title": "Port ID",
"description": "If PortID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch"
},
"ChassisId_PortId": {
"name": "ChassisId_PortId",
"type": "string",
"title": "Chassis ID and Port ID",
"description": "Combination primary key field",
"readonly": true
}
}
}
},
"subnets": {
"title": "Subnets",
"type": "array",
"items": {
"type": "object",
"properties": {
"Description": {
"name": "Description",
"type": "string",
"title": "Description",
"description": "Specifies the administrator defined description of the Location Information Service subnet."
},
"LocationId": {
"name": "LocationId",
"type": "string",
"title": "Location ID",
"description": "Specifies the unique identifier of the location",
"readonly": true
},
"Subnet": {
"name": "Subnet",
"type": "string",
"title": "Subnet",
"description": "The IP address of the subnet. This value can be either IPv4 or IPv6 format.",
"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*$))"
}
}
}
},
"switches": {
"title": "Switches",
"type": "array",
"items": {
"type": "object",
"properties": {
"Description": {
"name": "Description",
"type": "string",
"title": "Description",
"description": "Specifies the administrator defined description of the Location Information Service subnet."
},
"LocationId": {
"name": "LocationId",
"type": "string",
"title": "Location ID",
"description": "Specifies the unique identifier of the location",
"readonly": true
},
"ChassisId": {
"name": "ChassisId",
"type": "string",
"title": "Chassis ID",
"description": "If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch"
}
}
}
},
"waps": {
"title": "Waps",
"type": "array",
"items": {
"type": "object",
"properties": {
"Description": {
"name": "Description",
"type": "string",
"title": "Description",
"description": "Specifies the administrator defined description of the Location Information Service subnet."
},
"LocationId": {
"name": "LocationId",
"type": "string",
"title": "Location ID",
"description": "Specifies the unique identifier of the location",
"readonly": true
},
"BssId": {
"name": "BssId",
"type": "string",
"title": "BSS ID",
"description": "The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP location will be created. If an entry with the specified BSSID already exists, that entry will be replaced. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s)."
}
}
}
}
}
}
}
},
"schema_version": "1.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/EmergencyLocation/add/ |
|
The GUI Add form of relation/EmergencyLocation 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/relation/EmergencyLocation | 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/relation/EmergencyLocation/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/EmergencyLocation/[pkid1]", "/api/relation/EmergencyLocation/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/EmergencyLocation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/EmergencyLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/EmergencyLocation/export/ |
|
{ "hrefs":["/api/relation/EmergencyLocation/[pkid1]", "/api/relation/EmergencyLocation/[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/EmergencyLocation and the JSON format can be used to import instances of relation/EmergencyLocation.
GET http://[host-proxy]/api/relation/EmergencyLocation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/EmergencyLocation/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/EmergencyLocation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/EmergencyLocation/ |
|
The relation/EmergencyLocation schema and all instances as JSON. |
(The list will return 0 to 3 relation/EmergencyLocation instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "CompanyName",
"direction": "asc",
"current": "/api/relation/EmergencyLocation/?skip=0&limit=3&order_by=CompanyName&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"configuration_template",
"export",
"list",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/EmergencyLocation",
"summary_attrs": [
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "Default ELIN"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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/EmergencyLocation/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"configuration_template",
"export",
"list",
"get",
"export_bulkload_template"
],
"schema_version": "1.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/EmergencyLocation/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/EmergencyLocation/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/EmergencyLocation/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/EmergencyLocation/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/EmergencyLocation/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/EmergencyLocation/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/EmergencyLocation/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"DefaultLocationId": "039ed5d9-29bc-4a50-8d47-4c8bc65d9747",
"NumberOfVoiceUsers": -1,
"CompanyName": "Generico",
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"Longitude": "20",
"CivicAddressId": "0fd455c3-b2dd-407e-986a-e8a20de39744",
"ValidationStatus": "Validated",
"Latitude": "20",
"NumberOfTelephoneNumbers": -1,
"CountryOrRegion": "ZA",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "relation/EmergencyLocation",
"summary_attrs": [
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "Default ELIN"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Generico",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/",
"pkid": "6644f7a3f14dbdc7695fcb4b"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f7a3f14dbdc7695fcb4b"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6644f7a3f14dbdc7695fcb4b"
}
]
}
(Show the first instance)
{
"data": {
"DefaultLocationId": "039ed5d9-29bc-4a50-8d47-4c8bc65d9747",
"NumberOfVoiceUsers": -1,
"CompanyName": "Generico",
"Longitude": "20",
"CivicAddressId": "0fd455c3-b2dd-407e-986a-e8a20de39744",
"ValidationStatus": "Validated",
"Latitude": "20",
"NumberOfTelephoneNumbers": -1,
"CountryOrRegion": "ZA",
"locations": [
{
"NumberOfVoiceUsers": -1,
"CompanyName": "Generico",
"Longitude": "20",
"CivicAddressId": "0fd455c3-b2dd-407e-986a-e8a20de39744",
"PartnerId": "00000000-0000-0000-0000-000000000000",
"Location": "Generico_default",
"ValidationStatus": "Validated",
"Latitude": "20",
"LocationId": "039ed5d9-29bc-4a50-8d47-4c8bc65d9747",
"NumberOfTelephoneNumbers": -1,
"TenantId": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"CountryOrRegion": "ZA",
"IsDefault": true,
"ports": [],
"subnets": [],
"switches": [],
"waps": []
}
]
},
"meta": {
"model_type": "relation/EmergencyLocation",
"summary_attrs": [
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "Default ELIN"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Generico",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"children": [],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"self": [
{
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/",
"pkid": "6644f7a3f14dbdc7695fcb4b"
}
]
},
"schema_version": "1.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/EmergencyLocation/6644f7a3f14dbdc7695fcb4b/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "6644f7a3f14dbdc7695fcb4b"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/EmergencyLocation. | GET | /api/relation/EmergencyLocation/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/EmergencyLocation as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/EmergencyLocation/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/EmergencyLocation/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/EmergencyLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/EmergencyLocation/[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/EmergencyLocation and the JSON format can be used to import instances of relation/EmergencyLocation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/EmergencyLocation/[pkid] | hierarchy=[hierarchy] | The relation/EmergencyLocation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/EmergencyLocation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/EmergencyLocation. |