swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector TeamsCivicAddresses API
schemes:
- https
tags:
- name: TeamsCivicAddresses
paths:
  /accounts/{accountName}/teamsCivicAddresses:
    get:
      operationId: microsoftAzureAccountsListteamscivicaddresses
      tags:
      - TeamsCivicAddresses
      summary: Microsoft Azure Get Teams Civic Addresses
      description: Get a list of Teams Civic Addresses on the specified account.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/parameters/FilterQueryParameter'
      - $ref: '#/parameters/RecordCountQueryParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedTeamsCivicAddressResource'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
            x-ms-record-count:
              type: integer
              format: int32
              description: The total number of records available for this request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get a list of Civic Addresses.:
          $ref: ./examples/ListAccountTeamsCivicAddresses.json
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  PagedTeamsCivicAddressResource:
    type: object
    description: Paged collection of TeamsCivicAddressResource items
    properties:
      value:
        type: array
        description: The TeamsCivicAddressResource items on this page
        items:
          $ref: '#/definitions/TeamsCivicAddressResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  Location:
    type: object
    description: A location used by Team Operator Connect or Teams Phone Mobile telephone numbers.
    properties:
      id:
        type: string
        description: The ID of the location.
        minLength: 1
        readOnly: true
      civicAddressId:
        type: string
        description: The civic address ID of the location.
        minLength: 1
        readOnly: true
      description:
        type: string
        description: The description of the location.
        readOnly: true
      additionalInfo:
        type: string
        description: The additional information of the location.
        readOnly: true
      isDefault:
        type: boolean
        description: Flag indicating whether the location is default or not.
        readOnly: true
      elin:
        type: string
        description: The elin (Emergency Location Identification Number) of the location.
        readOnly: true
    required:
    - id
    - civicAddressId
  ValidationStatus:
    type: string
    description: The possible validation status of Teams Civic Addresses.
    enum:
    - notValidated
    - validated
    x-ms-enum:
      name: ValidationStatus
      modelAsString: true
      values:
      - name: notValidated
        value: notValidated
        description: The civic address is not validated.
      - name: validated
        value: validated
        description: The civic address is validated.
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  TeamsCivicAddressResource:
    type: object
    description: A civic address available for Teams Operator Connect or Teams Phone Mobile users.
    properties:
      id:
        type: string
        description: The ID of the civic address.
        minLength: 1
        readOnly: true
      country:
        type: string
        description: The country of the civic address.
        readOnly: true
      houseNumber:
        type: string
        description: The house number of the civic address.
        readOnly: true
      houseNumberSuffix:
        type: string
        description: The house number suffix of the civic address.
        readOnly: true
      preDirectional:
        type: string
        description: The pre directional of the civic address.
        readOnly: true
      streetName:
        type: string
        description: The street name of the civic address.
        readOnly: true
      streetSuffix:
        type: string
        description: The street suffix of the civic address.
        readOnly: true
      postDirectional:
        type: string
        description: The post directional of the civic address.
        readOnly: true
      stateOrProvince:
        type: string
        description: The state or province of the civic address.
        readOnly: true
      countyOrDistrict:
        type: string
        description: The county or district of the civic address.
        readOnly: true
      cityOrTown:
        type: string
        description: The city or town of the civic address.
        readOnly: true
      cityOrTownAlias:
        type: string
        description: The city or town alias of the civic address.
        readOnly: true
      postalOrZipCode:
        type: string
        description: The postal or zip code of the civic address.
        readOnly: true
      description:
        type: string
        description: The description of the civic address.
        readOnly: true
      companyName:
        type: string
        description: The company name of the civic address.
        readOnly: true
      companyId:
        type: string
        description: The company ID of the civic address.
        readOnly: true
      defaultLocationId:
        type: string
        description: The default location ID of the civic address.
        minLength: 1
        readOnly: true
      validationStatus:
        $ref: '#/definitions/ValidationStatus'
        description: The validation status of the civic address.
        readOnly: true
      tenantId:
        type: string
        description: The customer tenant ID of the civic address.
        readOnly: true
      partnerId:
        type: string
        description: The partner ID of the civic address.
        readOnly: true
      locations:
        type: array
        description: The list of locations associated with the civic address.
        items:
          $ref: '#/definitions/Location'
        readOnly: true
      latitude:
        type: string
        description: The latitude of the civic address.
        readOnly: true
      longitude:
        type: string
        description: The longitude of the civic address.
        readOnly: true
    required:
    - id
    - defaultLocationId
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  Azure.Core.ClientRequestIdHeader:
    name: x-ms-client-request-id
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    format: uuid
    x-ms-parameter-location: method
    x-ms-client-name: clientRequestId
  Azure.Core.TopQueryParameter:
    name: top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  RecordCountQueryParameter:
    name: countRecords
    in: query
    description: Whether to return a count of the total number of records available for this request.
    required: false
    type: boolean
    x-ms-parameter-location: method
  FilterQueryParameter:
    name: filter
    in: query
    description: Filter the result list using the given expression
    required: false
    type: string
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'