Sdílet prostřednictvím


Accounts - Get Teams Civic Address

Získejte Adresu pro občany v Teams.
Získejte podrobnosti o konkrétní občanské adrese Teams pomocí jejího ID.

GET https:///accounts/{accountName}/teamsCivicAddresses/{civicAddressId}?api-version=2024-02-29-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
accountName
path True

string

Název účtu.

Vzor regulárního výrazu: ^([A-Za-z0-9_-]+)$

civicAddressId
path True

string

ID místní adresy.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Požadavek by měl pokračovat pouze v případě, že entita odpovídá tomuto řetězci.

If-None-Match

string

Požadavek by měl pokračovat pouze v případě, že tomuto řetězci neodpovídá žádná entita.

If-Unmodified-Since

string

date-time

Požadavek by měl pokračovat pouze v případě, že entita nebyla po této době změněna.

If-Modified-Since

string

date-time

Požadavek by měl pokračovat pouze v případě, že se entita po této době změnila.

x-ms-client-request-id

string

uuid

Globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name Typ Description
200 OK

TeamsCivicAddressResource

Žádost byla úspěšná.

Hlavičky

  • ETag: string
  • x-ms-client-request-id: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď.

Hlavičky

x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: application
URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Rozsahy

Name Description
https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default

Příklady

Get a Civic Address.

Ukázkový požadavek

GET https:///accounts/contoso/teamsCivicAddresses/ebfee340-a791-11ed-9bfa-ed8bb5c41be4?api-version=2024-02-29-preview

Ukázková odpověď

{
  "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"
    }
  ]
}

Definice

Name Description
Azure.Core.Foundations.Error

Objekt chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Location

Umístění používané týmovým operátorem Connect nebo Telefon Teams mobilními telefonními čísly.

TeamsCivicAddressResource

Civilní adresa dostupná pro uživatele Teams Operator Connect nebo Telefon Teams Mobile.

ValidationStatus

Možný stav ověření pro Občanské adresy v Teams.

Azure.Core.Foundations.Error

Objekt chyby.

Name Typ Description
code

string

Jeden ze serverem definovaných chybových kódů.

details

Azure.Core.Foundations.Error[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.

innererror

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

message

string

Lidsky čitelná reprezentace chyby.

target

string

Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name Typ Description
error

Azure.Core.Foundations.Error

Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

string

Jeden ze serverem definovaných chybových kódů.

innererror

Azure.Core.Foundations.InnerError

Vnitřní chyba.

Location

Umístění používané týmovým operátorem Connect nebo Telefon Teams mobilními telefonními čísly.

Name Typ Description
additionalInfo

string

Další informace o umístění.

civicAddressId

string

ID místní adresy umístění.

description

string

Popis umístění.

elin

string

Elin (identifikační číslo místa tísňového volání) místa tísňového volání.

id

string

ID umístění.

isDefault

boolean

Příznak označující, jestli je umístění výchozí nebo ne.

TeamsCivicAddressResource

Civilní adresa dostupná pro uživatele Teams Operator Connect nebo Telefon Teams Mobile.

Name Typ Description
cityOrTown

string

Město nebo město občanské adresy.

cityOrTownAlias

string

Alias města nebo města občanské adresy.

companyId

string

ID společnosti občanské adresy.

companyName

string

Název společnosti občanské adresy.

country

string

Země občanské adresy.

countyOrDistrict

string

Okres nebo okres občanské adresy.

defaultLocationId

string

Výchozí ID umístění místní adresy.

description

string

Popis občanské adresy.

houseNumber

string

Číslo domu občanské adresy.

houseNumberSuffix

string

Přípona čísla domu občanské adresy.

id

string

ID místní adresy.

latitude

string

Zeměpisná šířka civilní adresy.

locations

Location[]

Seznam umístění přidružených k civilní adrese.

longitude

string

Zeměpisná délka civilní adresy.

partnerId

string

ID partnera místní adresy.

postDirectional

string

Směrová pošta občanské adresy.

postalOrZipCode

string

Psč nebo PSČ občanské adresy.

preDirectional

string

Předsměrová adresa občanského proslovu.

stateOrProvince

string

Stát nebo kraj občanské adresy.

streetName

string

Název ulice občanské adresy.

streetSuffix

string

Přípona ulice občanské adresy.

tenantId

string

ID tenanta zákazníka pro místní adresu.

validationStatus

ValidationStatus

Stav ověření civilní adresy.

ValidationStatus

Možný stav ověření pro Občanské adresy v Teams.

Name Typ Description
notValidated

string

Místní adresa se neověřuje.

validated

string

Místní adresa se ověří.