Avaya Location Profile API

openapi: 3.2.0
info:
  title: Admin - Voice Location Profile API
  description: 'The Voice provider APIs are used to manage information about voice specific elements and different voice related entities e.g. Phone numbers.


    Voice Services will support multiple ways to provision voice providers

    1. Programmatic Interface (Rest APIs)

    2. User Interface'
  contact:
    name: Avaya API Team
    url: https://developers.avayacloud.com/onecloud-ccaas
    email: apiteam@avaya.com
  license:
    name: Avaya Software Development Kit (SDK) Software License Terms
    url: http://support.avaya.com/css/P8/documents/101038288
  version: 1.0.2
servers:
- url: '{protocol}://{server}{basePath}'
  description: Open API
  variables:
    protocol:
      enum:
      - https
      default: https
    server:
      default: HOST-REGION.api.avayacloud.com
    basePath:
      default: /api/admin/voice/v1
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Location Profile
  description: This API is for managing location profiles. These API are expected to be called by an account administrator.
paths:
  /accounts/{accountId}/location-profiles:
    post:
      tags:
      - Location Profile
      summary: Create Location profile
      description: '**This API requires the Account Administrator role.**


        Creates an Location profile for specified account'
      operationId: createLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationProfile'
            examples:
              default:
                $ref: '#/components/examples/LocationProfileRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Location Profile
      summary: List all Location Profiles
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Location Profile by account Id'
      operationId: getAllLocationProfiles
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\nThe allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AHCG123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AHCG1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AHCG
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationProfiles'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfiles'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/location-profiles/{locationProfileId}:
    put:
      tags:
      - Location Profile
      summary: Update Location Profile
      description: '**This API requires the Account Administrator role.**


        Updates an existing Location Profile with Location Profile id by account id'
      operationId: updateLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationProfile'
            examples:
              default:
                $ref: '#/components/examples/LocationProfileRequest'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Location Profile
      summary: Get Location Profile
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Location Profile, based on Location Profile id and account id'
      operationId: getLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationProfile'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Location Profile
      summary: Delete Location Profile
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Location Profile identified by Location Profile id.'
      operationId: deleteLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      - $ref: '#/components/parameters/forceDelete'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  examples:
    LocationProfileRequest:
      description: Request model for creating and Updating an Location Profile
      value:
        name: Location Profile US
        description: Location Profile for US
        locationCode: IN-MH
        sipServerAddressList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnabled: true
    LocationProfileResponse:
      description: Response model for get an Location Profile
      value:
        id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
        name: Location Profile US
        description: Location Profile for US
        locationCode: IN-MH
        sipServerAddressList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnabled: true
        status: FAILED
    ErrorForbidden:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
        title: Forbidden
        status: 403
        detail: According to the access control policy the current user does not have permission to access this resource.
    ErrorConstraintViolation:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title: Constraint Violation
        status: 400
        detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
        violations:
        - field: accountId
          message: must match "^[a-zA-Z]{6}$"
          code: 20006
    ErrorMethodNotAllowed:
      description: Method not allowed
      value:
        title: Method not allowed
        status: 405
        detail: The request calls an HTTP method that is not supported at the resource.
    LocationProfiles:
      description: Location Profiles List Example
      value:
        pagination:
          pageNumber: 2
          pageSize: 3
          total: 10
        profiles:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: Location Profile1
          description: Location Profile 1
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: true
          status: SUCCESS
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed30
          name: Location Profile2
          description: Location Profile 2
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: true
          status: IN_PROGRESS
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed31
          name: Location Profile3
          description: Location Profile 3
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: false
          status: FAILED
        links:
          prev: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=1&pageSize=3
          next: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=3&pageSize=3
    LocationProfileAsyncResponse:
      description: A url response that is a reference to the Location Profile under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/location-profiles/5e9be49a-32d3-4927-83c7-7b0952798028
    ErrorNotFound:
      description: Not Found
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
        title: Resource Not Found
        status: 404
        detail: Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found.
    ErrorUnauthorized:
      description: Unauthorized
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
        title: Unauthorized
        status: 401
        detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
    ErrorConflict:
      description: Conflict
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: Communication Manager with same name already exists.
        - field: hostname
          message: Communication Manager with same hostname already exists.
    ErrorInternalServerError:
      description: Server Error
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
        title: Server Error
        status: 500
        detail: An internal server error was encountered.
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
    ErrorConstraintViolation:
      description: Constraint Violation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConstraintViolation'
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConflict'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    MethodNotAllowed:
      description: Method Not Allowed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorMethodNotAllowed'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
  parameters:
    accountId:
      name: accountId
      description: The unique 6 character internal id that represents the customer account.
      required: true
      in: path
      schema:
        type: string
        minLength: 6
        maxLength: 6
        pattern: ^[a-zA-Z]{6}$
        example: ABCDEF
    pageSize:
      name: pageSize
      in: query
      description: The max number of records to retrieve per page. Default value is 5, Any value like 5,10,15,20,25,30 is allowed. If value comes more than 1000 then max 1000 records will be returned.
      required: false
      schema:
        type: integer
        format: int32
        example: 5
        default: 5
        minimum: 1
        maximum: 50
    forceDelete:
      name: forceDelete
      description: To delete forcefully, set this parameter to true
      required: false
      in: query
      schema:
        type: boolean
        example: true
    locationProfileId:
      name: locationProfileId
      description: The unique id of the location Profile
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    pageNumber:
      name: pageNumber
      in: query
      description: The page number of the records to retrieve. Default value is 1.
      required: false
      schema:
        type: integer
        format: int32
        example: 1
        default: 1
        minimum: 1
  schemas:
    Links:
      type: object
      properties:
        prev:
          type: string
          description: URL of the previous page. Blank if currently on the first page.
        next:
          type: string
          description: URL of the next page. Blank if currently on the last page.
    LocationProfile:
      description: Location Profile
      type: object
      properties:
        id:
          type: string
          description: The unique id of Location Profile
          readOnly: true
          format: uuid
          example: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name:
          type: string
          example: Profile1
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Location Profile
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        locationCode:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        isMediaLatchingEnabled:
          type: boolean
          description: It is an indicator to enable or disable media latching feature through NGM
          example: true
          default: true
        sipServerAddressList:
          type: array
          items:
            type: string
            maxLength: 255
            pattern: ^[a-zA-Z0-9\p{L}\-\_\/\:\.\ ]+$
          minItems: 0
          maxItems: 50
          description: List of Fully-Qualified Domain-Name (FQDN) of all the SIP Server Address.
          example:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
        status:
          type: string
          description: Status of the object under operation
          readOnly: true
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          - PENDING_DELETE
          example: IN_PROGRESS
      required:
      - name
      - locationCode
    LocationProfiles:
      type: object
      description: List of Location Profile
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/LocationProfile'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=1&pageSize=3
            next: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=3&pageSize=3
    AsynchronousOperationResponse:
      type: object
      description: Represents the response for an asynchronous operation that simply returns a HATEOAS url, that provides a reference to the object under operation
      properties:
        url:
          type: string
          maxLength: 2048
    Pagination:
      type: object
      properties:
        pageNumber:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The max number of records that can be retrieved on this page.
        total:
          type: integer
          description: The total number of records.
    Problem:
      type: object
      description: '<b>Problem Detail</b> as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).

            '
          default: about:blank
          example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title:
          type:
          - string
          - 'null'
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).

            '
          example: Service Unavailable
        status:
          type:
          - integer
          - 'null'
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          example: 503
          exclusiveMaximum: 600
        detail:
          type:
          - string
          - 'null'
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type:
          - string
          - 'null'
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

            '
        violations:
          type:
          - array
          - 'null'
          description: 'A list of violations that occurred as a result of invalid data provided as part of a request.

            '
          items:
            type: object
            properties:
              field:
                type: string
                description: 'The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.

                  '
                example: accountId
              message:
                type: string
                description: 'A human readable explanation specific to this occurrence of the violation.

                  '
                example: must match "^[a-zA-Z]{6}$"
              code:
                type: integer
                format: int32
                description: 'The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.

                  '
                example: 20006
          example:
          - field: emailAddress
            message: must not be null
            code: 20002
          - field: accountId
            message: must match "^[a-zA-Z]{6}$"
            code: 20006
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: This API uses Bearer Token Authorization Flow
      bearerFormat: JWT
    AppKey:
      type: apiKey
      in: header
      name: appkey
      description: This API needs an appKey as header
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go