Dela via


Accounts - Get Teams Civic Address

Hämta Teams civicadress.
Få information om en specifik Teams Civic-adress med hjälp av dess ID.

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

URI-parametrar

Name I Obligatorisk Typ Description
accountName
path True

string

Namnet på kontot.

Reguljärt uttrycksmönster: ^([A-Za-z0-9_-]+)$

civicAddressId
path True

string

ID:t för den medborgerliga adressen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

Begäran bör endast fortsätta om en entitet matchar den här strängen.

If-None-Match

string

Begäran bör endast fortsätta om ingen entitet matchar den här strängen.

If-Unmodified-Since

string

date-time

Begäran bör endast fortsätta om entiteten inte har ändrats efter den här tiden.

If-Modified-Since

string

date-time

Begäran bör endast fortsätta om entiteten har ändrats efter den här tiden.

x-ms-client-request-id

string

uuid

En täckande, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name Typ Description
200 OK

TeamsCivicAddressResource

Begäran har slutförts.

Sidhuvuden

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

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: application
Token-webbadress: https://login.microsoftonline.com/common/oauth2/v2.0/token

Omfattningar

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

Exempel

Get a Civic Address.

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Azure.Core.Foundations.Error

Felobjektet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Location

En plats som används av Team Operator Connect eller Teams-telefon Mobile-telefonnummer.

TeamsCivicAddressResource

En giltig adress som är tillgänglig för Teams Operator Connect- eller Teams-telefon Mobile-användare.

ValidationStatus

Möjlig valideringsstatus för Teams civicadresser.

Azure.Core.Foundations.Error

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

details

Azure.Core.Foundations.Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.

innererror

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En mänsklig läsbar representation av felet.

target

string

Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name Typ Description
error

Azure.Core.Foundations.Error

Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

innererror

Azure.Core.Foundations.InnerError

Inre fel.

Location

En plats som används av Team Operator Connect eller Teams-telefon Mobile-telefonnummer.

Name Typ Description
additionalInfo

string

Ytterligare information om platsen.

civicAddressId

string

Platsens adress-ID.

description

string

Beskrivning av platsen.

elin

string

Elin (identifieringsnummer för nödsituationsplats) för platsen.

id

string

ID för platsen.

isDefault

boolean

Flagga som anger om platsen är standard eller inte.

TeamsCivicAddressResource

En giltig adress som är tillgänglig för Teams Operator Connect- eller Teams-telefon Mobile-användare.

Name Typ Description
cityOrTown

string

Staden eller staden för den medborgerliga adressen.

cityOrTownAlias

string

Ortens eller stadens alias för den medborgerliga adressen.

companyId

string

Företags-ID för den medborgerliga adressen.

companyName

string

Företagets namn på den medborgerliga adressen.

country

string

Landet för den medborgerliga adressen.

countyOrDistrict

string

Grevskapet eller distriktet för den medborgerliga adressen.

defaultLocationId

string

Standardplats-ID för den medborgerliga adressen.

description

string

Beskrivningen av den medborgerliga adressen.

houseNumber

string

Husnumret för den medborgerliga adressen.

houseNumberSuffix

string

Husnummersuffixet för den medborgerliga adressen.

id

string

ID:t för den medborgerliga adressen.

latitude

string

Latitud för den medborgerliga adressen.

locations

Location[]

Listan över platser som är associerade med den medborgerliga adressen.

longitude

string

Den medborgerliga adressens longitud.

partnerId

string

Partner-ID för den medborgerliga adressen.

postDirectional

string

Den posta directionalen av den medborgerliga tilltala.

postalOrZipCode

string

Den medborgerliga adressens postnummer eller postnummer.

preDirectional

string

Förriktningen för den medborgerliga adressen.

stateOrProvince

string

Staten eller provinsen för den medborgerliga adressen.

streetName

string

Gatunamnet på den medborgerliga adressen.

streetSuffix

string

Gatusuffixet för den medborgerliga adressen.

tenantId

string

Kundens klientorganisations-ID för den medborgerliga adressen.

validationStatus

ValidationStatus

Valideringsstatus för den medborgerliga adressen.

ValidationStatus

Möjlig valideringsstatus för Teams civicadresser.

Name Typ Description
notValidated

string

Den medborgerliga adressen är inte verifierad.

validated

string

Den medborgerliga adressen verifieras.