Alianza End User API

openapi: 3.2.0
info:
  title: Alianza End User API
  version: '2'
  description: 'Operations tagged End User across 3 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-end-user-api-openapi.yml, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
tags:
- name: End User
paths:
  /v2/partition/{partitionId}/account/{accountId}/user:
    get:
      tags:
      - End User
      summary: Get end user list
      description: Use to retrieve a list of end users. limitedData is provided to enable large result sets retreived without long retrieval times
      operationId: retrieveEndUserList
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: limitedData
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: EndUserV2X
                  $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid partition or account ID
        '404':
          description: Not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
          schema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid partition or account ID
        '404':
          description: Not found
    post:
      tags:
      - End User
      summary: Create end user
      description: Use to create a end user
      operationId: createEndUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid user object
        '404':
          description: User not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid user object
        '404':
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
        description: End user object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/user/prevalidate/email/{email}:
    get:
      tags:
      - End User
      summary: Prevalidate the end user's email address before saving the end user
      description: Use to prevalidate the email address. If the user hasn't been created yet, use as is. If the User already exists, provide qualified query param `userId`
      operationId: prevalidateEmailAddress
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: email
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: EndUserV2X
                  $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid partition, account ID, or user ID. Validation error if email is in use.
        '404':
          description: Not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
          schema:
            type: array
            items:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid partition, account ID, or user ID. Validation error if email is in use.
        '404':
          description: Not found
  /v2/partition/{partitionId}/account/{accountId}/user/activation:
    post:
      tags:
      - End User
      summary: End User activation
      description: (DEPRECATED) Use to create a new end user/device/csr to an existing account
      operationId: activation_1
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserActivationV2X
            $ref: '#/components/schemas/EndUserActivationV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserActivationV2X
                $ref: '#/components/schemas/EndUserActivationV2X'
        '400':
          description: Invalid end user activation object(s) supplied
        '404':
          description: Account not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserActivationV2X
            $ref: '#/components/schemas/EndUserActivationV2X'
          schema:
            originalRef: EndUserActivationV2X
            $ref: '#/components/schemas/EndUserActivationV2X'
        '400':
          description: Invalid end user activation object(s) supplied
        '404':
          description: Account not found
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              originalRef: EndUserActivationV2X
              $ref: '#/components/schemas/EndUserActivationV2X'
        description: Account activation object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}:
    get:
      tags:
      - End User
      summary: Retrieve end user
      description: Use to retrieve a end user
      operationId: retrieveEndUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      - name: idType
        in: query
        description: Defines if the Id is the userid for the username
        required: false
        schema:
          type: string
          enum:
          - Id
          - UserName
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid account ID or user ID
        '404':
          description: End user not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid account ID or user ID
        '404':
          description: End user not found
    put:
      tags:
      - End User
      summary: Update end user
      description: Use to update a end user
      operationId: updateEndUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
        description: End user object
        required: true
    delete:
      tags:
      - End User
      summary: Delete end user
      description: Use to delete a end user
      operationId: deleteEndUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Invalid end user ID
        '404':
          description: End user not found
      responsesObject:
        '400':
          description: Invalid end user ID
        '404':
          description: End user not found
    patch:
      tags:
      - End User
      summary: Update end user
      description: Use to update a end user
      operationId: patch_4
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              originalRef: EndUserV2X
              $ref: '#/components/schemas/EndUserV2X'
        description: End user object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/send-welcome-email:
    post:
      tags:
      - End User
      summary: Send welcome email to user
      description: Use to send a welcome email to the user
      operationId: sendWelcomeEmail
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '404':
          description: User not found
      responsesObject:
        '404':
          description: User not found
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanproduct/{callingPlanProductId}:
    put:
      tags:
      - End User
      summary: Change Calling Plan
      description: DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan.  If a pending calling plan already exists it will remove it and set the new calling plan
      operationId: changeCallingPlan_1
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      - name: callingPlanProductId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: CallingPlanX
                  $ref: '#/components/schemas/CallingPlanX'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          schema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
      deprecated: true
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanswap:
    post:
      tags:
      - End User
      summary: Change Calling Plan Immediately
      description: DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan
      operationId: swapCallingPlan_1
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: CallingPlanX
                  $ref: '#/components/schemas/CallingPlanX'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          schema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              originalRef: CallingPlanSwapX
              $ref: '#/components/schemas/CallingPlanSwapX'
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/cancelpendingcallingplan:
    delete:
      tags:
      - End User
      summary: ' Cancel Pending Callingplan'
      description: DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan
      operationId: cancelPendingCallingPlan_1
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: CallingPlanX
                  $ref: '#/components/schemas/CallingPlanX'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
          schema:
            type: array
            items:
              originalRef: CallingPlanX
              $ref: '#/components/schemas/CallingPlanX'
      deprecated: true
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/voicemail:
    get:
      tags:
      - End User
      summary: Retrieve end user voicemail
      description: Use to retrieve a end user's voicemail
      operationId: getVoicemailData
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: VoicemailMessageX
              $ref: '#/components/schemas/VoicemailMessageX'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: VoicemailMessageX
                  $ref: '#/components/schemas/VoicemailMessageX'
        '400':
          description: Invalid account ID or end user ID
        '404':
          description: Account or end user not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: VoicemailMessageX
              $ref: '#/components/schemas/VoicemailMessageX'
          schema:
            type: array
            items:
              originalRef: VoicemailMessageX
              $ref: '#/components/schemas/VoicemailMessageX'
        '400':
          description: Invalid account ID or end user ID
        '404':
          description: Account or end user not found
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/unlockvm:
    put:
      tags:
      - End User
      summary: Unlock end user voicemail
      description: Use to unlock a end user's voicemail
      operationId: unlockVm
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      - name: resetPin
        in: query
        description: New voicemail Pin
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid user ID or pin
        '404':
          description: End user not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid user ID or pin
        '404':
          description: End user not found
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/resetpassword:
    put:
      tags:
      - End User
      summary: Reset end user password
      description: Use to reset the password of a end user
      operationId: resetPassword_2
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID
        '404':
          description: User not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID
        '404':
          description: User not found
  /v2/partition/{partitionId}/account/{accountId}/user/{userId}/repurpose:
    put:
      tags:
      - End User
      summary: Repurpose an existing user to be a different user (end user swap)
      description: Use to reuse a user for a new user
      operationId: repurposeEndUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          content:
            application/json:
              schema:
                originalRef: EndUserV2X
                $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
          schema:
            originalRef: EndUserV2X
            $ref: '#/components/schemas/EndUserV2X'
        '400':
          description: Invalid end user ID or user object
        '404':
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              originalRef: ReassignEndUserX
              $ref: '#/components/schemas/ReassignEndUserX'
        description: End user data to overwrite existing user data
        required: true
components:
  schemas:
    ScheduleX:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - CUSTOM
          - WEEKLY
        weekly:
          type: object
          additionalProperties:
            originalRef: WeeklyScheduleX
            $ref: '#/components/schemas/WeeklyScheduleX'
        custom:
          type: array
          items:
            originalRef: CustomScheduleX
            $ref: '#/components/schemas/CustomScheduleX'
    E911AddressX:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        middleInitial:
          type: string
        lastName:
          type: string
        businessName:
          type: string
        streetNumber:
          type: string
        streetNumberSuffix:
          type: string
        preDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        streetName:
          type: string
        streetSuffix:
          type: string
        postDirectional:
          type: string
          enum:
          - ''
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        secondaryLocationDescription:
          type: string
          enum:
          - ''
          - APARTMENT
          - BUILDING
          - BASEMENT
          - DEPARTMENT
          - FLOOR
          - FRONT
          - HANGER
          - KEY
          - LOBBY
          - LOT
          - LOWER
          - OFFICE
          - PENTHOUSE
          - PIER
          - REAR
          - ROOM
          - SIDE
          - SLIP
          - SPACE
          - SUITE
          - STOP
          - TRAILER
          - UNIT
          - UPPER
        unit:
          type: string
        customerType:
          type: string
          enum:
          - BUSINESS
          - RESIDENTIAL
        latitude:
          type: string
          description: -90 through 90, 4-6 decimals
        longitude:
          type: string
          description: -180 through 180, 4-6 decimals
        language:
          type: string
          description: Optional, see /v2/ref/language for supported languages
    MediaFriendsX:
      type: object
      properties:
        enabled:
          type: boolean
        host:
          type: string
        toNumber:
          type: string
    RingPhoneCallHandlingX:
      type: object
      properties:
        busyCallHandling:
          originalRef: CallHandlingX
          $ref: '#/components/schemas/CallHandlingX'
        noAnswerCallHandling:
          originalRef: CallHandlingWithTimeoutX
          $ref: '#/components/schemas/CallHandlingWithTimeoutX'
        unregisteredCallHandling:
          originalRef: CallHandlingX
          $ref: '#/components/schemas/CallHandlingX'
    DeviceX:
      type: object
      required:
      - accountId
      - deviceName
      - deviceTypeId
      - faxEnabled
      - id
      - partitionId
      - userId
      properties:
        id:
          type: string
        deviceTypeId:
          type: string
        accountId:
          type: string
        partitionId:
          type: string
        macAddress:
          type: string
        deviceName:
          type: string
        emergencyNumber:
          type: string
          description: Required if emergencyNumberReservationId is abs

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/openapi/alianza-end-user-api-openapi.yml