Delen via


Accounts - Get Teams Civic Address

Teams Civic Address ophalen.
Details van een specifiek Teams Civic-adres ophalen met behulp van de bijbehorende id.

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

URI-parameters

Name In Vereist Type Description
accountName
path True

string

Naam van het account.

Regex-patroon: ^([A-Za-z0-9_-]+)$

civicAddressId
path True

string

De id van het burgeradres.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
If-Match

string

De aanvraag moet alleen worden uitgevoerd als een entiteit overeenkomt met deze tekenreeks.

If-None-Match

string

De aanvraag moet alleen worden uitgevoerd als er geen entiteit overeenkomt met deze tekenreeks.

If-Unmodified-Since

string

date-time

De aanvraag mag alleen doorgaan als de entiteit na deze tijd niet is gewijzigd.

If-Modified-Since

string

date-time

De aanvraag mag alleen doorgaan als de entiteit na deze tijd is gewijzigd.

x-ms-client-request-id

string

uuid

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name Type Description
200 OK

TeamsCivicAddressResource

De aanvraag is geslaagd.

Kopteksten

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

Azure.Core.Foundations.ErrorResponse

Een onverwacht foutbericht.

Kopteksten

x-ms-error-code: string

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: application
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Bereiken

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

Voorbeelden

Get a Civic Address.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Azure.Core.Foundations.InnerError

Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Location

Een locatie die wordt gebruikt door Team Operator Connect of Teams Telefoon Mobiele telefoonnummers.

TeamsCivicAddressResource

Een adres dat beschikbaar is voor gebruikers van Teams Operator Connect of Teams Telefoon Mobile.

ValidationStatus

De mogelijke validatiestatus van Teams Civic Addresses.

Azure.Core.Foundations.Error

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

Azure.Core.Foundations.Error[]

Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.

innererror

Azure.Core.Foundations.InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

target

string

Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name Type Description
error

Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.InnerError

Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

innererror

Azure.Core.Foundations.InnerError

Interne fout.

Location

Een locatie die wordt gebruikt door Team Operator Connect of Teams Telefoon Mobiele telefoonnummers.

Name Type Description
additionalInfo

string

De aanvullende informatie over de locatie.

civicAddressId

string

De adres-id van de locatie.

description

string

De beschrijving van de locatie.

elin

string

De elin (Identificatienummer voor locatie van noodgeval) van de locatie.

id

string

De id van de locatie.

isDefault

boolean

Vlag die aangeeft of de locatie standaard is of niet.

TeamsCivicAddressResource

Een adres dat beschikbaar is voor gebruikers van Teams Operator Connect of Teams Telefoon Mobile.

Name Type Description
cityOrTown

string

De plaats van het adres.

cityOrTownAlias

string

De plaatsalias van het burgeradres.

companyId

string

De bedrijfs-id van het burgeradres.

companyName

string

De bedrijfsnaam van het adres.

country

string

Het land van het burgeradres.

countyOrDistrict

string

De provincie of het district van het adres.

defaultLocationId

string

De standaardlocatie-id van het burgeradres.

description

string

De beschrijving van het adres.

houseNumber

string

Het huisnummer van het burgeradres.

houseNumberSuffix

string

Het huisnummerachtervoegsel van het burgeradres.

id

string

De id van het burgeradres.

latitude

string

De breedtegraad van het adres.

locations

Location[]

De lijst met locaties die zijn gekoppeld aan het adres van de woonplaats.

longitude

string

De lengtegraad van het adres.

partnerId

string

De partner-id van het burgeradres.

postDirectional

string

De postrichting van het adres.

postalOrZipCode

string

De postcode van het burgeradres.

preDirectional

string

De voorrichting van het adres.

stateOrProvince

string

De staat of provincie van het adres.

streetName

string

De straatnaam van het burgeradres.

streetSuffix

string

Het straatachtervoegsel van het adres.

tenantId

string

De tenant-id van de klant van het burgeradres.

validationStatus

ValidationStatus

De validatiestatus van het burgeradres.

ValidationStatus

De mogelijke validatiestatus van Teams Civic Addresses.

Name Type Description
notValidated

string

Het burgeradres is niet gevalideerd.

validated

string

Het burgeradres wordt gevalideerd.