Telenor Sverige Fixed Network Quotation Response API

openapi: 3.2.0
info:
  title: Fixed Network Quotation Response API
  description: 'API managing fixed network quotations at Telenor Sweden AB

    >

    The Fixed Network Quotation API goal is to provide quotations commercial eligibility at Telenor. The API consists of a set of operations that interact with Catalog- and Inventory systems in a consistent manner. This API is intended for software developers and system integrators implementing client applications for handling products and offerings. It is assumed that the reader is familiar with software API concepts such as REST, JSON and the OpenAPI interface specification. For more information about OpenAPI see OpenAPI Specification.

    ### Response Codes

    This API follows standard response codes for REST APIs defined in HTTP RFC by W3C Note that not all 4xx HTTP Status Codes are explicit documented in each API-operation such as **401 (UNAUTHORIZED)** and **403 (FORBIDDEN)**. These are considered generic ones and clients should be aware their presence at all operations.'
  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.1.13
servers:
- url: https://apis.telenor.se/corporate/
  description: Production environment
- url: https://apis-test.telenor.se/corporate/
  description: Test environment
tags:
- name: Fixed Network Quotation Response
  description: APIs which manages quotations for the various fixed network products commercial available in the product catalog.
paths:
  /fixed-network/quotation/response:
    get:
      tags:
      - Fixed Network Quotation Response
      summary: Find all quotes responses
      description: Returns all quote responses for the authenticated caller or empty array if no quote responses exist.
      operationId: QuotationResponseResource_findAll
      parameters:
      - name: limit
        in: query
        description: The number of result to return
        schema:
          type: integer
          format: int32
          examples:
          - 10
          default: 50
          maximum: 100
          minimum: 1
      - name: next
        in: query
        description: a continuation token used to fetch the next page when the number of results is larger that the limit
        schema:
          type: string
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        schema:
          type: string
      responses:
        x-codeSamples:
        - lang: Java
          source: 'var client = HttpClient.newHttpClient();

            var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

            var resp = client.send(request, BodyHandlers.ofString());

            System.out.println(response.body());'
        - lang: JavaScript
          source: 'var http = new XMLHttpRequest();

            http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

            http.send();

            console.log(http.responseText);'
        '200':
          description: Successful operation
          x-codeSamples:
          - lang: Java
            source: 'var client = HttpClient.newHttpClient();

              var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

              var resp = client.send(request, BodyHandlers.ofString());

              System.out.println(response.body());'
          - lang: JavaScript
            source: 'var http = new XMLHttpRequest();

              http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

              http.send();

              console.log(http.responseText);'
          content:
            application/json:
              schema:
                properties:
                  continuationToken:
                    examples:
                    - YmRlZDJmZDUtYzkxYi00MGFkLWFjYjQtNWFmNDljY2IzMzM5
                    description: An opaque string that may be provided in a subsequent request to fetch the next results. If not present it indicates that no remaining items exist.
                  quoteResponses:
                    type: array
                    items:
                      $ref: '#/components/schemas/QuoteResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          x-codeSamples:
          - lang: Java
            source: 'var client = HttpClient.newHttpClient();

              var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

              var resp = client.send(request, BodyHandlers.ofString());

              System.out.println(response.body());'
          - lang: JavaScript
            source: 'var http = new XMLHttpRequest();

              http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

              http.send();

              console.log(http.responseText);'
      security:
      - bearer-jwt: []
      x-codeSamples:
      - lang: Java
        source: 'var client = HttpClient.newHttpClient();

          var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

          var resp = client.send(request, BodyHandlers.ofString());

          System.out.println(response.body());'
      - lang: JavaScript
        source: 'var http = new XMLHttpRequest();

          http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

          http.send();

          console.log(http.responseText);'
  /fixed-network/quotation/response/{quoteId}:
    get:
      tags:
      - Fixed Network Quotation Response
      summary: Finds a quote response by id
      description: Returns a quote response for a previous quote request by the supplied quote id.
      operationId: QuotationResponseResource_findResponseQuoteBy
      parameters:
      - name: quoteId
        in: path
        description: The quote id
        required: true
        schema:
          type: string
        example: 1f4aa2c9-c35b-446c-90b5-2037e717520b
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        schema:
          type: string
      responses:
        x-codeSamples:
        - lang: Java
          source: 'var client = HttpClient.newHttpClient();

            var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

            var resp = client.send(request, BodyHandlers.ofString());

            System.out.println(response.body());'
        - lang: JavaScript
          source: 'var http = new XMLHttpRequest();

            http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

            http.send();

            console.log(http.responseText);'
        '200':
          description: Successful operation
          x-codeSamples:
          - lang: Java
            source: 'var client = HttpClient.newHttpClient();

              var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

              var resp = client.send(request, BodyHandlers.ofString());

              System.out.println(response.body());'
          - lang: JavaScript
            source: 'var http = new XMLHttpRequest();

              http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

              http.send();

              console.log(http.responseText);'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          x-codeSamples:
          - lang: Java
            source: 'var client = HttpClient.newHttpClient();

              var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

              var resp = client.send(request, BodyHandlers.ofString());

              System.out.println(response.body());'
          - lang: JavaScript
            source: 'var http = new XMLHttpRequest();

              http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

              http.send();

              console.log(http.responseText);'
      security:
      - bearer-jwt: []
      x-codeSamples:
      - lang: Java
        source: 'var client = HttpClient.newHttpClient();

          var req = HttpRequest.newBuilder().uri(URI.create(uri)).build();

          var resp = client.send(request, BodyHandlers.ofString());

          System.out.println(response.body());'
      - lang: JavaScript
        source: 'var http = new XMLHttpRequest();

          http.open(''GET'', ''https://<base-uri>/fixed-network/<path-to-resource>'', false);

          http.send();

          console.log(http.responseText);'
components:
  schemas:
    DeliveryStatus:
      type: object
      description: Contains information about the possibility to delivery the requested service.
      properties:
        reason:
          type: string
          examples:
          - Requested service has been verified it can be delivered on requested site
          description: A reason for the quote response status
        status:
          $ref: '#/components/schemas/Status'
          type: string
          description: Different status for the requested service. CONFIRMED means the service can be delivered while REJECTED means the service for some reason can't be delivered
          default: ACCEPTED
    SignatureRepresentation:
      type: string
      enum:
      - DIGITAL
      - MANUAL
    Price:
      type: object
      required:
      - priceType
      - cost
      properties:
        name:
          type: string
          examples:
          - Tariff plan 25 fee
          description: The name of the tariff
        priceType:
          $ref: '#/components/schemas/PriceType'
          type: string
          description: The price type
        currency:
          type: string
          examples:
          - SEK
          description: The currency
          default: SEK
        cost:
          type: integer
          format: int32
          examples:
          - 1000
          description: The actual cost, excluding any value-added tax (VAT) rate or discounts
          minimum: 0
        vatTaxRate:
          type: integer
          format: int32
          examples:
          - 25
          description: The value-added tax (VAT) rate in percent (%)
          default: 25
        quantity:
          type: integer
          format: int32
          examples:
          - 1
          description: The quantity
    Status:
      type: string
      enum:
      - ACCEPTED
      - REJECTED
    PriceAlternation:
      type: object
      required:
      - name
      - priceType
      - discount
      description: Describes any alternation to the original price
      properties:
        applicationDuration:
          type: string
          examples:
          - '12'
          description: The duration of the price alternation
        description:
          type: string
          examples:
          - Specific Discount for Acme company
          description: The description of the price alternation
        name:
          type: string
          examples:
          - 10% off
          description: The name of the price alternation
        priceType:
          $ref: '#/components/schemas/PriceType'
          type: string
          description: The price type
        discount:
          type: string
          examples:
          - 10%
          description: The actual discount, could be in percent (%) or fixed amount
    QuoteResponse:
      type: object
      required:
      - appId
      - authorizer
      properties:
        quoteId:
          type: string
          readOnly: true
          description: The id for the quotation
        deliveryStatus:
          $ref: '#/components/schemas/DeliveryStatus'
        appId:
          type: string
          examples:
          - 902da9e6-4d7c-4bee-ad55-a60ff6b7d994
          pattern: ^(?!unknown).*
          description: The appId (client or subject) to receive this this quote
        organizationNumber:
          type: string
          examples:
          - 0123456798
          description: Organization number for which quotation was made
        category:
          type: string
          examples:
          - Fixed network connectivity quote
          description: The category of this quote
        expectedFulfillmentStartDate:
          $ref: '#/components/schemas/LocalDate'
          type: string
          deprecated: true
          description: Estimated start date of the the fulfillment for this quote.The field will be replaced by 'expectedDeliveryDays' with relative amount of days instead of absolute date.
        expectedDeliveryDays:
          type: integer
          format: int32
          description: Expected number of working days before delivery.
        expectedQuoteCompletionDate:
          $ref: '#/components/schemas/LocalDate'
          type: string
          description: Completion date for this quote
        authorizer:
          $ref: '#/components/schemas/Authorizer'
        quoteItems:
          type: array
          maxItems: 1
          minItems: 1
          items:
            $ref: '#/components/schemas/QuoteItem'
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          examples:
          - INVALID_PARAMETERS
          description: '## Errors

            ### INVALID_PARAMETERS

            Invalid input parameter(s).

            ### INTERNAL_ERROR

            Internal error.

            ### TIMEOUT

            Timeout occurred when communicating with underlying systems.

            ### QUOTE_GROUP_ALREADY_CLOSED

            Quote group already in state CLOSED.

            ### QUOTE_GROUP_ALREADY_EXISTS

            Quote group with given id already exists.

            ### QUOTE_GROUP_NOT_FOUND

            Quote group with given id can''t be found.

            ### MISSING_AUTHORIZATION_HEADER

            Header with authorization data is missing.

            ### BROADBAND_NOT_AVAILABLE_ON_ADDRESS

            Bredband via fiber not possible to deliver on address.

            ### NOT_ALLOWED_TO_QUOTE_ON_BEHALF_OF

            The supplied appId is not allowed to create quotes on behalf of another organization number.

            ### SITE_IS_INACTIVE

            The site is in inactive state.

            '
        message:
          type: string
          description: Human readable message of the error
        timestamp:
          type: integer
          format: int64
          description: timestamp (Epoch) when error occurred
    AdditionalService:
      type: object
      properties:
        additionalServiceId:
          type: integer
          exclusiveMinimum: 0
          format: int32
          examples:
          - 4806
          description: The Id of the additional service from Product Catalog
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameters'
    PriceType:
      type: string
      enum:
      - RECURRING_MONTHLY
      - ONE_TIME_FEE
      - HOURLY_RATE
    Parameters:
      type: object
      properties:
        parameterId:
          type: integer
          exclusiveMinimum: 0
          format: int32
          examples:
          - 7984
          description: The Id of the additional service parameter from Product Catalog
    LocalDate:
      type: string
      format: date
      examples:
      - 2022-03-10
    ProductSpecification:
      type: object
      description: Represent a product specification from the product catalog.
      properties:
        productId:
          type: integer
          exclusiveMinimum: 0
          format: int32
        qualityOfServiceId:
          type: integer
          format: int32
          minimum: 0
        accessRedundancyId:
          type: integer
          format: int32
          minimum: 0
        accessTypeId:
          type: integer
          format: int32
          minimum: 0
        accessSpeedId:
          type: integer
          format: int32
          minimum: 0
        serviceLevelAgreementId:
          type: integer
          format: int32
          minimum: 0
        serviceLevelAgreementLevelId:
          type: integer
          format: int32
          minimum: 0
        additionalServices:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalService'
    QuoteItem:
      type: object
      required:
      - bindingTime
      - quantity
      - quoteResourceUrl
      - prices
      description: Represent an item from the product catalog with price, binding time, etc.
      properties:
        bindingTime:
          type: integer
          format: int32
          examples:
          - 36
          description: The binding time (in months) for the quotation
          minimum: 0
        quantity:
          type: integer
          exclusiveMinimum: 0
          format: int32
          examples:
          - 10
          description: The number of products
        quoteResourceUrl:
          type: string
          examples:
          - https://apis.telenor.se/corporate/fixed-network/quotation/request/site/1f4aa2c9-c35b-446c-90b5-2037e717520b
          pattern: \S
          description: An link to the quote request resource
        prices:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Price'
        priceAlternations:
          type: array
          items:
            $ref: '#/components/schemas/PriceAlternation'
        products:
          type: array
          items:
            $ref: '#/components/schemas/ProductSpecification'
    Authorizer:
      type: object
      required:
      - approverName
      - signatureRepresentation
      properties:
        approverName:
          type: string
          examples:
          - John Doe
          pattern: \S
          description: The name of the quote approver
        approvalRole:
          type: string
          examples:
          - B2B Discount approver
          description: The role of the approver
        responseCreationDate:
          $ref: '#/components/schemas/LocalDate'
          type: string
          description: When the quotation response was created. If omitted, current date will be used.
        signatureRepresentation:
          $ref: '#/components/schemas/SignatureRepresentation'
  securitySchemes:
    bearer-jwt:
      type: http
      description: Telenor Sweden bearer token (JWT)
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: API Operations
  tags:
  - Fixed Network Quotation Request
  - Fixed Network Quotation Response
  - Fixed Network Quotation Groups
x-servers:
- url: http://127.0.0.1:8080/
  description: Local dev environment
- url: http://b2bapis-test.se.telenor.net
  description: Test (internal) environment
- url: https://apis-test.telenor.se/corporate/
  description: Test (external) environment
- url: http://apis.se.telenor.net/corporate/
  description: Prod (external) environment
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/fixed-network-quotation/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)