Partilhar via


Accounts - Get Teams Civic Address

Obtenha o Endereço Cívico do Teams.
Obtenha detalhes de um Endereço Cívico do Teams específico com o respetivo ID.

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

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
path True

string

Nome da conta.

Padrão Regex: ^([A-Za-z0-9_-]+)$

civicAddressId
path True

string

O ID do endereço cívico.

api-version
query True

string

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

O pedido só deve prosseguir se uma entidade corresponder a esta cadeia.

If-None-Match

string

O pedido só deve continuar se nenhuma entidade corresponder a esta cadeia.

If-Unmodified-Since

string

date-time

O pedido só deve prosseguir se a entidade não tiver sido modificada após este período de tempo.

If-Modified-Since

string

date-time

O pedido só deve prosseguir se a entidade tiver sido modificada após este período de tempo.

x-ms-client-request-id

string

uuid

Um identificador de cadeia opaco, globalmente exclusivo, gerado pelo cliente para o pedido.

Respostas

Name Tipo Description
200 OK

TeamsCivicAddressResource

O pedido foi bem-sucedido.

Cabeçalhos

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

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Âmbitos

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

Exemplos

Get a Civic Address.

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Location

Uma localização utilizada pelo Team Operator Connect ou Telefone Teams Números de telefone móveis.

TeamsCivicAddressResource

Um endereço cívico disponível para utilizadores do Teams Operator Connect ou Telefone Teams Mobile.

ValidationStatus

O possível estado de validação dos Endereços Cívicos do Teams.

Azure.Core.Foundations.Error

O objeto de erro.

Name Tipo Description
code

string

Um dos conjuntos de códigos de erro definidos pelo servidor.

details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.

innererror

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

message

string

Uma representação legível por humanos do erro.

target

string

O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Name Tipo Description
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Tipo Description
code

string

Um dos conjuntos de códigos de erro definidos pelo servidor.

innererror

Azure.Core.Foundations.InnerError

Erro interno.

Location

Uma localização utilizada pelo Team Operator Connect ou Telefone Teams Números de telefone móveis.

Name Tipo Description
additionalInfo

string

As informações adicionais da localização.

civicAddressId

string

O ID do endereço cívico da localização.

description

string

A descrição da localização.

elin

string

O elin (Número de Identificação da Localização de Emergência) da localização.

id

string

O ID da localização.

isDefault

boolean

Sinalizador a indicar se a localização é predefinida ou não.

TeamsCivicAddressResource

Um endereço cívico disponível para utilizadores do Teams Operator Connect ou Telefone Teams Mobile.

Name Tipo Description
cityOrTown

string

A cidade ou cidade do endereço cívico.

cityOrTownAlias

string

A cidade ou alias da cidade do endereço cívico.

companyId

string

O ID da empresa do endereço cívico.

companyName

string

O nome da empresa do endereço cívico.

country

string

O país do endereço cívico.

countyOrDistrict

string

O concelho ou distrito do endereço cívico.

defaultLocationId

string

O ID de localização predefinido do endereço cívico.

description

string

A descrição do endereço cívico.

houseNumber

string

O número da casa do endereço cívico.

houseNumberSuffix

string

O sufixo número da casa do endereço cívico.

id

string

O ID do endereço cívico.

latitude

string

A latitude do endereço cívico.

locations

Location[]

A lista de localizações associadas ao endereço cívico.

longitude

string

A longitude do endereço cívico.

partnerId

string

O ID do parceiro do endereço cívico.

postDirectional

string

O post directional do endereço cívico.

postalOrZipCode

string

O código postal ou postal do endereço cívico.

preDirectional

string

A pré-direcional do endereço cívico.

stateOrProvince

string

O estado ou a província do endereço cívico.

streetName

string

O nome da rua do endereço cívico.

streetSuffix

string

O sufixo da rua do endereço cívico.

tenantId

string

O ID do inquilino do cliente do endereço cívico.

validationStatus

ValidationStatus

O estado de validação do endereço cívico.

ValidationStatus

O possível estado de validação dos Endereços Cívicos do Teams.

Name Tipo Description
notValidated

string

O endereço cívico não é validado.

validated

string

O endereço cívico é validado.