Nokia Network as Code Number Recycling v0.2 API

openapi: 3.2.0
info:
  title: Nokia Network As Code Number Recycling v0.2 API
  version: 1.0.0
  termsOfService: https://developer.networkascode.nokia.io/legal/terms-of-service
  x-refined-note:
  - x-badges differs across the merged source definitions and was not carried
  - x-camara-commonalities differs across the merged source definitions and was not carried
  - x-category differs across the merged source definitions and was not carried
  - x-collections differs across the merged source definitions and was not carried
  - x-long-description differs across the merged source definitions and was not carried
  - x-public differs across the merged source definitions and was not carried
  - x-thumbnail differs across the merged source definitions and was not carried
  - x-version-lifecycle differs across the merged source definitions and was not carried
  - x-website differs across the merged source definitions and was not carried
  description: 'Operations tagged Number Recycling v0.2 across 2 of this provider''s published API definitions: nokia-network-as-code-camara-openapi.yml, nokia-network-as-code-platform-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{apiRoot}/geofencing-subscriptions/v0.3'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: '{apiRoot}/geofencing-subscriptions/v0.4'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: https://network-as-code.p-eu.rapidapi.com
tags:
- name: Number Recycling v0.2
paths:
  /passthrough/camara/v1/number-recycling/number-recycling/v0.2/check:
    post:
      security:
      - openId:
        - number-recycling:check
      tags:
      - Number Recycling v0.2
      summary: Check whether the subscriber of the phone number has changed.
      description: Check whether the subscriber of the phone number has changed.
      operationId: checkNumberRecycling
      parameters:
      - $ref: '#/components/parameters/x-correlator-NUMR-RECYCL-V0'
      - in: header
        name: authorization
        required: false
        description: authorization header for token
        schema:
          type: string
      requestBody:
        description: Check whether the subscriber of the phone number has changed.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCheckNumRecycling-NUMR-RECYCL-V0'
            examples:
              CHECK_NUMBER_RECYCLING:
                value:
                  phoneNumber: '+99999991000'
                  specifiedDate: '2024-10-31'
              CHECK_NUMBER_RECYCLING_REQUEST_3_LEGGED:
                summary: Example request without phone number when using three-legged access token
                value:
                  specifiedDate: '2024-10-31'
      responses:
        '200':
          $ref: '#/components/responses/Generic200-NUMR-RECYCL-V0'
        '400':
          $ref: '#/components/responses/Generic400-NUMR-RECYCL-V0'
        '401':
          $ref: '#/components/responses/Generic401-NUMR-RECYCL-V0'
        '403':
          $ref: '#/components/responses/Generic403-NUMR-RECYCL-V0'
        '404':
          $ref: '#/components/responses/Generic404-NUMR-RECYCL-V0'
        '422':
          $ref: '#/components/responses/Generic422-NUMR-RECYCL-V0'
    servers:
    - url: '{apiRoot}/geofencing-subscriptions/v0.3'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
    - url: '{apiRoot}/geofencing-subscriptions/v0.4'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
components:
  responses:
    Generic401-NUMR-RECYCL-V0:
      description: Authentication problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-NUMR-RECYCL-V0'
            - type: object
              properties:
                status:
                  enum:
                  - 401
                code:
                  enum:
                  - UNAUTHENTICATED
          examples:
            Unauthenticated:
              description: Request cannot be authenticated and a new authentication is required
              value:
                status: 401
                code: UNAUTHENTICATED
                message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
    Generic400-NUMR-RECYCL-V0:
      description: Problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-NUMR-RECYCL-V0'
            - type: object
              properties:
                status:
                  enum:
                  - 400
                code:
                  enum:
                  - INVALID_ARGUMENT
                  - OUT_OF_RANGE
          examples:
            InvalidArgument:
              description: Invalid Argument. Generic Syntax Exception
              value:
                status: 400
                code: INVALID_ARGUMENT
                message: Client specified an invalid argument, request body or query param.
            OutOfRange:
              description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
              value:
                status: 400
                code: OUT_OF_RANGE
                message: Client specified an invalid range.
    Generic403-NUMR-RECYCL-V0:
      description: Client does not have sufficient permission
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-NUMR-RECYCL-V0'
            - type: object
              properties:
                status:
                  enum:
                  - 403
                code:
                  enum:
                  - PERMISSION_DENIED
          examples:
            Permission Denied:
              description: Permission denied. OAuth2 token access not have the required scope or when the user fails operational security
              value:
                status: 403
                code: PERMISSION_DENIED
                message: Client does not have sufficient permissions to perform this action
    Generic422-NUMR-RECYCL-V0:
      description: Unprocessable Content
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-NUMR-RECYCL-V0'
            - type: object
              properties:
                status:
                  enum:
                  - 422
                code:
                  enum:
                  - SERVICE_NOT_APPLICABLE
                  - MISSING_IDENTIFIER
                  - UNNECESSARY_IDENTIFIER
          examples:
            Device Not Applicable:
              description: Service not applicable for the provided phone number
              value:
                status: 422
                code: SERVICE_NOT_APPLICABLE
                message: The service is not available for the provided phone number
            Unnecessary Identifier:
              description: An explicit identifier is provided when a phone number has already been identified from the access token
              value:
                status: 422
                code: UNNECESSARY_IDENTIFIER
                message: The phone number is already identified by the access token
            Missing Identifier:
              description: An identifier is not included in the request and the phone number identification cannot be derived from the 3-legged access token
              value:
                status: 422
                code: MISSING_IDENTIFIER
                message: The phone number cannot be identified
    Generic200-NUMR-RECYCL-V0:
      description: OK
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CheckNumRecyclingInfo-NUMR-RECYCL-V0'
    Generic404-NUMR-RECYCL-V0:
      description: Resource Not Found
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-NUMR-RECYCL-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-NUMR-RECYCL-V0'
            - type: object
              properties:
                status:
                  enum:
                  - 404
                code:
                  enum:
                  - IDENTIFIER_NOT_FOUND
          examples:
            Phone Number Used By Different Network Operator:
              description: Provided phone number is used by a different network operator
              value:
                status: 404
                code: IDENTIFIER_NOT_FOUND
                message: Phone number not found.
  schemas:
    PhoneNumber-NUMR-RECYCL-V0:
      description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
      type: string
      pattern: ^\+[1-9][0-9]{4,14}$
      example: '+123456789'
    CreateCheckNumRecycling-NUMR-RECYCL-V0:
      type: object
      required:
      - specifiedDate
      properties:
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumber-NUMR-RECYCL-V0'
        specifiedDate:
          type: string
          format: date
          description: Specified date to check whether there has been a change in the subscriber associated with the specific phone number, in RFC 3339 calendar date format (YYYY-MM-DD).
          example: '2024-10-31'
    ErrorInfo-NUMR-RECYCL-V0:
      type: object
      required:
      - status
      - code
      - message
      properties:
        status:
          type: integer
          description: HTTP response status code
        code:
          type: string
          description: A human-readable code to describe the error
        message:
          type: string
          description: A human-readable description of what the event represents
    XCorrelator-NUMR-RECYCL-V0:
      type: string
      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
      example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
    CheckNumRecyclingInfo-NUMR-RECYCL-V0:
      type: object
      required:
      - phoneNumberRecycled
      properties:
        phoneNumberRecycled:
          type: boolean
          description: 'Set to true (Boolean, not string) when there has been a change in the subscriber associated with the specific phone number after “specifiedDate”.

            '
  parameters:
    x-correlator-NUMR-RECYCL-V0:
      name: x-correlator
      in: header
      description: Correlation id for the different services
      schema:
        $ref: '#/components/schemas/XCorrelator-NUMR-RECYCL-V0'
    x-rapidapi-host:
      name: x-rapidapi-host
      in: header
      required: true
      description: The API's Host value as defined in the RapidAPI Hub.
      schema:
        type: string
        example: network-as-code.p-eu.rapidapi.com
  headers:
    x-correlator-NUMR-RECYCL-V0:
      description: Correlation id for the different services
      schema:
        $ref: '#/components/schemas/XCorrelator-NUMR-RECYCL-V0'
  securitySchemes:
    openId:
      description: OpenID Connect authentication
      type: openIdConnect
      openIdConnectUrl: https://example.com/.well-known/openid-configuration
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-rapidapi-key
      description: Your RapidAPI key
externalDocs:
  description: Project documentation at Camara
  url: https://github.com/camaraproject/DeviceLocation
x-refined-from:
- nokia-network-as-code-camara-openapi.yml
- nokia-network-as-code-platform-openapi.json