次の方法で共有


Accounts - List Teams Civic Addresses

Teams の Civic Addresses を取得します。
指定したアカウントの Teams Civic Addresses の一覧を取得します。

GET https:///accounts/{accountName}/teamsCivicAddresses?api-version=2024-02-29-preview
GET https:///accounts/{accountName}/teamsCivicAddresses?api-version=2024-02-29-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}&filter={filter}&countRecords={countRecords}

URI パラメーター

名前 / 必須 説明
accountName
path True

string

アカウントの名前。

正規表現パターン: ^([A-Za-z0-9_-]+)$

api-version
query True

string

この操作に使用する API バージョン。

countRecords
query

boolean

この要求で使用できるレコードの合計数を返すかどうか。

filter
query

string

指定された式を使用して結果一覧をフィルター処理する

maxpagesize
query

integer

int32

1 ページあたりの結果アイテムの最大数。

skip
query

integer

int32

スキップする結果項目の数。

top
query

integer

int32

返す結果項目の数。

要求ヘッダー

名前 必須 説明
x-ms-client-request-id

string

uuid

要求の不透明でグローバルに一意のクライアント生成文字列識別子。

応答

名前 説明
200 OK

PagedTeamsCivicAddressResource

要求は成功しました。

ヘッダー

  • x-ms-client-request-id: string
  • x-ms-record-count: integer
Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

OAuth2Auth

型: oauth2
フロー: application
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/v2.0/token

スコープ

名前 説明
https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default

Get a list of Civic Addresses.

要求のサンプル

GET https:///accounts/contoso/teamsCivicAddresses?api-version=2024-02-29-preview&countRecords=True

応答のサンプル

x-ms-record-count: 1
{
  "value": [
    {
      "id": "ebfee340-a791-11ed-9bfa-ed8bb5c41be4",
      "country": "US",
      "houseNumber": "11600",
      "streetName": "Sunrise Valley",
      "stateOrProvince": "VA",
      "cityOrTown": "Reston",
      "postalOrZipCode": "20191",
      "companyName": "contoso",
      "defaultLocationId": "653c9fed-f8a7-4a6c-917b-b5b1ad4d45f7",
      "validationStatus": "validated",
      "tenantId": "a7f4bd5c-cc01-40f4-8baa-2b6bdb272b8a",
      "locations": [
        {
          "id": "653c9fed-f8a7-4a6c-917b-b5b1ad4d45f7",
          "civicAddressId": "ebfee340-a791-11ed-9bfa-ed8bb5c41be4",
          "isDefault": true,
          "description": "911"
        }
      ]
    }
  ]
}

定義

名前 説明
Azure.Core.Foundations.Error

error オブジェクト。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

Location

Team Operator Connect または Teams 電話 Mobile の電話番号で使用される場所。

PagedTeamsCivicAddressResource

TeamsCivicAddressResource アイテムの Paged コレクション

TeamsCivicAddressResource

Teams オペレーター Connect または Teams 電話 Mobile ユーザーが利用できる市民用アドレス。

ValidationStatus

Teams Civic Addresses の検証状態。

Azure.Core.Foundations.Error

error オブジェクト。

名前 説明
code

string

サーバー定義のエラー コードのセットの 1 つ。

details

Azure.Core.Foundations.Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

Azure.Core.Foundations.InnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。

message

string

エラーの人間が判読できる表現。

target

string

エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前 説明
error

Azure.Core.Foundations.Error

error オブジェクト。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

名前 説明
code

string

サーバー定義のエラー コードのセットの 1 つ。

innererror

Azure.Core.Foundations.InnerError

内部エラー。

Location

Team Operator Connect または Teams 電話 Mobile の電話番号で使用される場所。

名前 説明
additionalInfo

string

場所の追加情報。

civicAddressId

string

場所の市民アドレス ID。

description

string

場所の説明。

elin

string

場所の elin (緊急位置情報識別番号)。

id

string

場所の ID。

isDefault

boolean

場所が既定かどうかを示すフラグ。

PagedTeamsCivicAddressResource

TeamsCivicAddressResource アイテムの Paged コレクション

名前 説明
nextLink

string

アイテムの次のページへのリンク

value

TeamsCivicAddressResource[]

このページの TeamsCivicAddressResource アイテム

TeamsCivicAddressResource

Teams オペレーター Connect または Teams 電話 Mobile ユーザーが利用できる市民用アドレス。

名前 説明
cityOrTown

string

市民住所の都市または町。

cityOrTownAlias

string

市民住所の市または町の別名。

companyId

string

市民住所の会社 ID。

companyName

string

市民住所の会社名。

country

string

市民住所の国。

countyOrDistrict

string

市民住所の郡または地区。

defaultLocationId

string

市民住所の既定の場所 ID。

description

string

市民の住所の説明。

houseNumber

string

市民住所の家番号。

houseNumberSuffix

string

市民住所の家番号サフィックス。

id

string

市民の住所の ID。

latitude

string

市民住所の緯度。

locations

Location[]

市民の住所に関連付けられている場所の一覧。

longitude

string

市民住所の経度。

partnerId

string

市民住所のパートナー ID。

postDirectional

string

市民の住所のポスト方向。

postalOrZipCode

string

市民住所の郵便番号。

preDirectional

string

市民住所の事前方向。

stateOrProvince

string

市民住所の州または州。

streetName

string

市民住所の通りの名前。

streetSuffix

string

市民住所の番地サフィックス。

tenantId

string

市民アドレスの顧客テナント ID。

validationStatus

ValidationStatus

市民住所の検証状態。

ValidationStatus

Teams Civic Addresses の検証状態。

名前 説明
notValidated

string

市民住所は検証されません。

validated

string

市民住所が検証されます。