Telenor Sverige Termination API

openapi: 3.2.0
info:
  title: Product Inventory Management Termination API
  description: 'The Product Inventory Management API provides a standardized mechanism to manage product inventory information. The API consists of a simple set of operations that interact with Inventory systems in a consistent manner.''

    ### Notifications

    When a Request is sent to the backend systems, its lifecycle state changes and an event is sent to the Event Notification API. The notification `detailedMessage` attribute will have the following content, depending on the type of request:

    #### General requests

    ```

    {

    "message": "The request is in progress.",

    "requestId": "bf13697e-ab73-4a75-bc1b-903147594d11"

    }

    ```

    #### Termination requests

    ```

    {

    "message": "The request is in progress.",

    "id": "bf13697e-ab73-4a75-bc1b-903147594d11",

    "type": "termination",

    "products": [

    {

    "productId": "SID2532144",

    "state": "IN_PROGRESS"

    }

    ]

    }'
  termsOfService: https://www.telenor.se/globalassets/mediabibliotek/telenor-foretag/pdfer/priser-och-villkor/general-terms-and-conditions-october-2012.pdf
  contact:
    name: Telenor Support
    url: https://www.telenor.se/foretag/kundservice/
  version: 2.4.17
servers:
- url: https://apis-test.telenor.se
  description: Test environment
tags:
- name: Termination
  description: Endpoints for requesting products to be terminated.
paths:
  /corporate/fixed-network/product-inventory-management/v1/product/termination/{requestId}:
    get:
      tags:
      - Termination
      summary: Fetches a termination request of a product inventory item
      description: Fetches a termination request of a product inventory item.
      operationId: getTerminationRequest
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: requestId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Termination request successfully fetched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminationResponse'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Termination
      summary: Attempts to cancel a termination request of a product inventory item
      description: 'Attempts to cancel a termination request of a product inventory item.


        Termination requests that have a desired termination date within the next 7 days cannot be cancelled.'
      operationId: cancelTerminationRequest
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: requestId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Termination request successfully cancelled.
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
  /corporate/fixed-network/product-inventory-management/v1/product/termination:
    get:
      tags:
      - Termination
      summary: Lists all termination requests for a customer
      description: Lists all termination requests for a customer.
      operationId: getCustomerTerminationRequests
      parameters:
      - name: pageSize
        in: query
        description: The number of items each page should contain.
        schema:
          type: integer
          format: int32
          default: 10
        example: 10
      - name: pageNumber
        in: query
        description: The number of the page in the list of results.
        schema:
          type: integer
          format: int32
          default: 1
        example: 1
      - name: organizationNumber
        in: query
        description: Filter termination requests by organization number.
        schema:
          type: string
        example: 5564210309
      responses:
        '200':
          description: Termination requests successfully fetched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResultTerminationResponses'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Termination
      summary: Terminate product inventory items
      description: 'Requests the termination of product inventory items.


        Termination requests will remain in the `NEW` state for 3 days before they move into `IN_PROGRESS`.

        During this period it is possible to cancel the termination request via the provided endpoints.

        Upon a successful termination, the request will transition from `IN_PROGRESS` to `COMPLETED`.'
      operationId: terminate
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AddTerminationRequest'
      responses:
        '201':
          description: New termination request successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminationResponse'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PaginatedResultTerminationResponses:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/BasicPaginatedResultMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/TerminationResponse'
    BasicPaginatedResultMeta:
      type: object
      properties:
        totalRecords:
          type: integer
          format: int64
        pageSize:
          type: integer
          format: int32
        pageNumber:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: The reason that caused the error.
          example: The provided product offer does not exist.
        code:
          type: string
          description: An application specific error code to differentiate error responses.
          example: MISSING_REQUIRED_PARAMETER
          enum:
          - MISSING_REQUIRED_PARAMETER
          - INVALID_INPUT
          - CANCELLATION_OF_TERMINATION_NOT_POSSIBLE
          - TERMINATION_REQUEST_ALREADY_CANCELLED
          - TERMINATION_REQUEST_RETRIGGER_NOT_POSSIBLE
          - TERMINATION_OF_PRODUCT_NOT_POSSIBLE
          - TERMINATION_PRODUCTS_MUST_BELONG_TO_THE_SAME_SITE
          - INVALID_JWT
          - UNAUTHORIZED_HEADER_USAGE
          - UNAUTHORIZED
          - LAN_PORT_REQUEST_NOT_FOUND
          - STATIC_ROUTE_REQUEST_NOT_FOUND
          - DHCP_RELAY_REQUEST_NOT_FOUND
          - TERMINATION_REQUEST_NOT_FOUND
          - PRODUCT_NOT_FOUND
          - AGREEMENT_NOT_FOUND
          - AGREEMENT_STRUCTURE_NOT_FOUND
          - VPN_REQUEST_NOT_FOUND
          - SITE_NOT_FOUND
          - REQUEST_NOT_FOUND
          - TOO_MANY_REQUESTS
          - INTERNAL_ERROR
          - CLARIFY_ERROR
          - MISSING_AGREEMENT_IN_CAS
          - SALESFORCE_ERROR
        timestamp:
          type: integer
          description: The date and time using the epoch standard of when the error occurred.
          format: int64
          example: 1615292025
    TerminationResponse:
      type: object
      properties:
        requestId:
          type: string
          description: A unique identifier for the request.
          format: uuid
          example: 2d5b553d-f4c2-4803-b64a-ed903e1dde0f
        products:
          type: array
          description: The list of products to be terminated.
          items:
            $ref: '#/components/schemas/ProductResponse'
        desiredTerminationDate:
          type: string
          description: A desired date for when the products should be terminated.
          format: date
          example: '2020-09-13'
        sendTechnician:
          type: boolean
          description: Indicates if a technician should be sent out to assist with the termination
          example: true
        contactPersons:
          type: array
          items:
            $ref: '#/components/schemas/ContactPersonRequest'
        state:
          type: string
          description: The state in which the request is.
          example: IN_PROGRESS
          enum:
          - NEW
          - PARTIALLY_PROCESSED
          - IN_PROGRESS
          - CANCELLED
          - COMPLETED
        createdDate:
          type: string
          description: The date and time that the request was received by the API.
          format: date-time
          example: '2019-08-24T14:15:22Z'
        onBehalfOfOrgNr:
          type: string
          description: The organization number on behalf of which the request was made.
          example: '5566778899'
    AddTerminationRequest:
      required:
      - contactPersons
      - products
      type: object
      properties:
        products:
          minItems: 1
          type: array
          description: The list of products to be terminated.
          items:
            $ref: '#/components/schemas/ProductRequest'
        desiredTerminationDate:
          type: string
          description: A desired date for when the products should be terminated. It should be more than 3 days in the future
          format: date
          example: '2020-09-13'
        sendTechnician:
          type: boolean
          description: Indicates if a technician should be sent out to assist with the termination
          example: true
        contactPersons:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ContactPersonRequest'
        productIds:
          uniqueItems: true
          type: array
          items:
            type: string
    ProductRequest:
      required:
      - productId
      type: object
      properties:
        productId:
          type: string
          description: The installed product ID.
          example: SID5134123
        luNumber:
          type: string
          description: The LU Number of the CPE.
          example: '2361292'
      description: The list of products to be terminated.
    ContactPersonRequest:
      required:
      - email
      - firstName
      - lastName
      type: object
      properties:
        firstName:
          minLength: 1
          type: string
          description: The first name of the person to be contacted.
          example: Jane
        lastName:
          minLength: 1
          type: string
          description: The last name of the person to be contacted.
          example: Doe
        email:
          type: string
          description: The e-mail address of the contact person.
          format: email
          example: jane.doe@telenor.se
        phoneNumber:
          type: string
          description: The phone number of the person to be contacted. Phone number should consist only of digits, spaces, dashes with optional leading plus. Will be set from mobile number if missing.
          example: 0999000009
        mobileNumber:
          type: string
          description: The mobile number of the contact person. Phone number should consist only of digits, spaces, dashes with optional leading plus.
          example: 0790000000
        type:
          type: string
          description: Represents the type of information the person can provide when contacted.
          example: TECHNICAL
          enum:
          - GENERAL
          - TECHNICAL
          - LOCAL_CONTACT
    ProductResponse:
      type: object
      properties:
        productId:
          type: string
          description: The installed product ID.
          example: SID5134123
        luNumber:
          type: string
          description: The LU Number of the CPE.
          example: '2361292'
        state:
          type: string
          description: The state of the product termination request.
          example: COMPLETED
          enum:
          - IN_PROGRESS
          - COMPLETED
          - UNKNOWN
        caseId:
          type: string
          description: The ID of the case in Telenor's internal systems.
          example: '124123'
      description: The list of products to be terminated.
x-tagGroups:
- name: API Operations
  tags:
  - Product Inventory
  - VPN
  - Static Routes
  - DHCP Relay
  - LAN Ports
  - Termination
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/product-inventory/openapi
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)