[Index]
Model ref.: view/MicrosoftOperatorConnectUploadNumberRange
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": {
"TenantId": {
"title": "Tenant",
"description": "Tenant",
"type": "string",
"format": "uri",
"required": true,
"target": "/api/device/msoperatorconnect/PartnerOperatorConsents/choices/?field=TenantId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "TenantId",
"target_model_type": "device/msoperatorconnect/PartnerOperatorConsents",
"choices": []
},
"CallingProfileId": {
"title": "Calling Profile",
"description": "Calling Profile",
"type": "string",
"format": "uri",
"required": true,
"target": "/api/device/msoperatorconnect/CallingProfilesV2/choices/?field=Id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Id",
"target_model_type": "device/msoperatorconnect/CallingProfilesV2",
"choices": []
},
"Usage": {
"title": "Usage",
"description": "Usage",
"type": "string",
"required": true
},
"ChoosableCapabilities": {
"title": "Choosable Capabilities",
"description": "Choosable Capabilities",
"type": "array",
"required": true,
"items": {
"type": "string",
"choices": []
}
},
"ProductContext": {
"title": "Product Context",
"description": "Product Context",
"type": "string",
"required": true,
"default": "teams"
},
"DisplayedCountryCode": {
"title": "Displayed Country Code",
"description": "Displayed Country Code",
"type": "string",
"required": true,
"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"
}
]
},
"StartTelephoneNumber": {
"title": "Start Telephone Number",
"description": "Start Telephone Number",
"type": "string",
"required": true
},
"Range": {
"title": "Range [1-1000]",
"description": "Range bewtween 1 and 1000",
"type": "string",
"required": true,
"pattern": "^([1-9][0-9]{0,2}|1000)$",
"default": "1"
},
"TicketId": {
"title": "Ticket Id",
"description": "Ticket Id",
"type": "string",
"required": false
},
"AllowTenantAddressUpdate": {
"title": "Allow Tenant Address Update",
"description": "Allow Tenant Address Update",
"type": "boolean",
"default": true
},
"CivicAddressId": {
"title": "Civic Address",
"description": "Civic Address",
"type": "string",
"required": false
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/MicrosoftOperatorConnectUploadNumberRange/add/ |
|
The GUI Add form of view/MicrosoftOperatorConnectUploadNumberRange 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/view/MicrosoftOperatorConnectUploadNumberRange | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/MicrosoftOperatorConnectUploadNumberRange | POST | /api/view/MicrosoftOperatorConnectUploadNumberRange/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/MicrosoftOperatorConnectUploadNumberRange/ |
|
The view/MicrosoftOperatorConnectUploadNumberRange schema and all instances as JSON. |
(The list will return 0 to 3 view/MicrosoftOperatorConnectUploadNumberRange instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/MicrosoftOperatorConnectUploadNumberRange/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/MicrosoftOperatorConnectUploadNumberRange",
"summary_attrs": [
{
"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": [
"add"
],
"schema_version": "1.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/MicrosoftOperatorConnectUploadNumberRange/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/MicrosoftOperatorConnectUploadNumberRange/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/MicrosoftOperatorConnectUploadNumberRange/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/MicrosoftOperatorConnectUploadNumberRange/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/MicrosoftOperatorConnectUploadNumberRange. | GET | /api/view/MicrosoftOperatorConnectUploadNumberRange/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/MicrosoftOperatorConnectUploadNumberRange as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/MicrosoftOperatorConnectUploadNumberRange/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/MicrosoftOperatorConnectUploadNumberRange. |