Elevation - Get Data For Polyline

透過聚合線條取得提高許可權的資料。
適用于: S1 定價層。

「取得聚合線條 API 的資料」可透過聚合線條提供提高許可權的資料。 聚合線條的定義方式是在2和 N 端點座標之間傳遞,並以管道分隔 ( ' | ') 字元。 除了傳入端點之外,客戶還可以指定要用來將聚合線條分割成同樣間距區段的範例點數目。 系統會傳回起點和終點的提高許可權資料,以及聚合線的平均間距點。 兩個端點之間的線條是直線笛卡兒線,這是座標參考系統中這兩個點之間的最短線。 請注意,此點是根據 Euclidean 距離選擇,而且可能明顯不同于沿著參考橢圓體的曲線表面的量測路徑。

GET https://atlas.microsoft.com/elevation/line/json?api-version=1.0&lines={lines}
GET https://atlas.microsoft.com/elevation/line/json?subscription-key={subscription-key}&api-version=1.0&lines={lines}&samples={samples}

URI 參數

Name In Required Type Description
format
path True

所需的回應格式。 僅支援 json 格式。

api-version
query True
  • string

Azure 地圖服務 API 的版本號碼。 目前的版本為1。0

lines
query True
  • array

聚合線條路徑的字串表示。 聚合線條是由端點座標所定義,每個端點都以管道分隔 ( ' | ') 字元。 聚合線條應以下列格式定義: [longitude_point1,latitude_point1 | longitude_point2,latitude_point2,...,longitude_pointN,latitude_pointN]。 經度和緯度值指的是 World Geodetic System (WGS84) 座標參考系統。 用來計算提高許可權之資料的解析將取決於端點之間的距離。

samples
query
  • number

Samples 參數會指定在聚合線條路徑中應提供提高許可權值的平均間距點數目。 樣本數的範圍應介於2到2000之間。 如果未提供,則預設值為10。

subscription-key
query
  • string

從 Azure 地圖帳戶提供的其中一個 Azure 地圖服務金鑰。 如需如何管理驗證的詳細資訊,請參閱這 篇文章

要求標頭

Name Required Type Description
x-ms-client-id
  • string

指定要搭配 Azure AD 的安全性模型使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一識別碼,而且可以從 Azure 地圖服務管理平面帳戶 API 中取出。 若要在 Azure 地圖服務中使用 Azure AD 安全性,請參閱下列 文章 以取得指導方針。

回應

Name Type Description
200 OK

確定

400 Bad Request

不正確的要求:有一或多個參數未正確指定或互斥。

401 Unauthorized

因為訂用帳戶金鑰無效或 Azure Active Directory 持有人權杖無效,所以拒絕存取。 請務必為有效的 Azure 訂用帳戶和地圖資源提供有效的金鑰。 否則,請驗證 WWW 驗證 標頭中的錯誤碼,以及所提供的 AAD 持有人權杖的描述。

Headers

  • WWW-Authenticate: string
403 Forbidden

許可權、容量或驗證問題。

404 Not Found

找不到:找不到要求的資源,但未來可能會再次提供。

500 Internal Server Error

處理這個要求時發生錯誤。 請稍後再試一次。

安全性

azure_auth

這些是 Azure Active Directory 的 OAuth2 流程。 與 Azure 角色型訪問 控制搭配使用時,可用來控制 Azure 地圖服務 REST api 的存取權。 Azure 角色型存取控制可用來指定對一或多個 Azure 地圖服務資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一個或多個許可權所組成的自訂角色來授與 Azure 地圖服務 REST Api 的存取權。

若要執行案例,我們建議您查看 驗證概念。 總而言之,此安全性定義提供的解決方案可讓您透過可對特定 Api 和範圍進行存取控制的物件來建立應用程式 () 的模型。

注意

  • 此安全性定義 需要 使用 x-ms-client-id 標頭,以指出應用程式要求存取的 Azure 地圖服務資源。 這可以從 Maps 管理 API取得。
  • Authorization URL適用于 Azure 公用雲端實例。 主權 cloud 具有唯一的授權 Url 和 Azure Active directory 設定。
  • Azure 角色型存取控制是透過 Azure 入口網站、Powershell、CLI、Azure Sdk 或 REST Api,從 azure 管理平面 進行設定。
  • 使用 Azure 地圖服務 WEB SDK 可讓您針對多個使用案例來設定應用程式的設定。
  • 目前支援 Azure Active Directory v1.0 權杖。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

這是在透過 Azure 管理平面透過 Azure 入口網站、Powershell、CLI、Azure Sdk 或 REST Api 建立 Azure 地圖服務資源 時所布建的共用金鑰。 使用此金鑰,任何應用程式都有權存取所有 REST Api。 換句話說,這些金鑰目前可以視為其所發出之帳戶的主要金鑰。 對於公開的應用程式,我們建議使用伺服器存取 Azure 地圖服務 REST Api (可安全地儲存此金鑰)的伺服器存取。

Type: apiKey
In: query

範例

GetDataForPolyLine

Sample Request

GET https://atlas.microsoft.com/elevation/line/json?subscription-key=[subscription-key]&api-version=1.0&lines=-121.66853362143818, 46.84646479863713|-121.67853362143818, 46.85646479863713&samples=5

Sample Response

{
  "data": [
    {
      "coordinate": {
        "latitude": 46.846464798637129,
        "longitude": -121.66853362143819
      },
      "elevationInMeter": 2298.6581875651746
    },
    {
      "coordinate": {
        "latitude": 46.848964798637127,
        "longitude": -121.67103362143818
      },
      "elevationInMeter": 2466.4058976953679
    },
    {
      "coordinate": {
        "latitude": 46.851464798637124,
        "longitude": -121.67353362143818
      },
      "elevationInMeter": 2504.8855800948654
    },
    {
      "coordinate": {
        "latitude": 46.853964798637129,
        "longitude": -121.67603362143818
      },
      "elevationInMeter": 2477.8929009638578
    },
    {
      "coordinate": {
        "latitude": 46.856464798637127,
        "longitude": -121.67853362143818
      },
      "elevationInMeter": 2394.5290079897059
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

定義

Coordinate

以緯度和經度表示的位置。

JsonFormat

所需的回應格式。 僅支援 json 格式。

LinesResult

成功提高許可權的聚合線條要求回應。

ODataError

當 Maps API 中發生錯誤時,就會傳回此物件。

ODataErrorResponse

當 Maps API 中發生錯誤時,會傳回此回應物件。

PointElevationResult

提高許可權的資料。

Coordinate

以緯度和經度表示的位置。

Name Type Description
latitude
  • number

緯度屬性

longitude
  • number

經度屬性

JsonFormat

所需的回應格式。 僅支援 json 格式。

Name Type Description
json
  • string

JavaScript 物件標記法資料交換格式

LinesResult

成功提高許可權的聚合線條要求回應。

Name Type Description
data

從取得聚合線條 API 取得資料的回應。 結果會列在從第一個端點到最後一個端點的方向中。

ODataError

當 Maps API 中發生錯誤時,就會傳回此物件。

Name Type Description
code
  • string

ODataError 碼。

details

當 Maps API 中發生錯誤時,就會傳回此物件。

message
  • string

人類看得懂的錯誤描述 (若可取得)。

target
  • string

如果有的話,則會造成錯誤。

ODataErrorResponse

當 Maps API 中發生錯誤時,會傳回此回應物件。

Name Type Description
error

當 Maps API 中發生錯誤時,就會傳回此物件。

PointElevationResult

提高許可權的資料。

Name Type Description
coordinate

以緯度和經度表示的位置。

elevationInMeter
  • number

量值(以量值為單位)。