Telenor Sverige Accounts API

openapi: 3.2.0
info:
  title: managing Fixed Network Install Base Accounts API
  description: 'APIs that provides access to the Fixed Installed Base for external parties who want to enrich their data. 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 explicitly documented in each API operation such as 401 (UNAUTHORIZED) and 403 (FORBIDDEN). These are considered generic ones and clients should be aware of their presence at all operations.'
  contact:
    name: API Support
    url: https://www.telenor.se/foretag/kundservice/
  version: 1.0.0
servers:
- url: http://localhost:8080/
  description: Localhost
- url: https://safe-external-test.se.telenor.net/
  description: Internal Test environment
- url: https://apis-test.telenor.se/corporate/fixed-network/install-base/
  description: Test environment
- url: https://apis.telenor.se/corporate/fixed-network/install-base/
  description: Production environment
tags:
- name: Accounts
paths:
  /v1/accounts/{objectId}:
    get:
      tags:
      - Accounts
      summary: Gets an account by its unique objectId
      operationId: GET_v1/accounts/{objectId}
      parameters:
      - name: objectId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountDto'
  /v1/accounts:
    get:
      tags:
      - Accounts
      summary: Fetch accounts from the supplied parameters
      operationId: GET_v1/accounts
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The number of items to return. Max is 1000
        schema:
          type: integer
          description: The number of items to return. Max is 1000
          format: int32
      - name: organizationId
        in: query
        description: Organization number, can be both swedish or foreign
        schema:
          maxLength: 20
          minLength: 0
          type: string
      - name: kurtId
        in: query
        description: ID provided by Norway to identify customers using Nordic Connect services
        schema:
          maxLength: 30
          minLength: 0
          type: string
      - name: accountId
        in: query
        description: Internal account id
        schema:
          maxLength: 40
          minLength: 0
          type: string
      - name: accountStatus
        in: query
        description: Status of the account
        schema:
          $ref: '#/components/schemas/EntityStatus'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAccountsResponse'
components:
  schemas:
    EntityStatus:
      enum:
      - Active
      - Inactive
      - Obsolete
      type: string
      description: Represents the status of a number of resources such Accounts, Sites, etc.
    AccountDto:
      title: Account
      type: object
      properties:
        objectId:
          type: integer
          description: Unique identifier for the account
          format: int64
        organizationId:
          type:
          - string
          - 'null'
          description: The organization number, can be both swedish or foreign
        name:
          type:
          - string
          - 'null'
          description: Name of the account
        kurtId:
          type:
          - string
          - 'null'
          description: KurtId for the account, if applicable
        accountId:
          type:
          - string
          - 'null'
          description: AccountId for the account
        dataQualityStatus:
          type:
          - string
          - 'null'
          description: Data quality status for the account
        status:
          $ref: '#/components/schemas/EntityStatus'
        businessType:
          type:
          - string
          - 'null'
          description: The business type for the account
        legalStatus:
          type:
          - string
          - 'null'
          description: Legal status for the account
        type:
          type:
          - string
          - 'null'
          description: Type for the account
        typeCode:
          type:
          - string
          - 'null'
          description: Type code for the account
        baseCountry:
          type:
          - string
          - 'null'
          description: The base country for the account
      additionalProperties: false
      description: Represent a customer account such as 'Telenor Sverige AB'.
    PagedData:
      title: Meta
      type: object
      properties:
        first:
          type:
          - integer
          - 'null'
          format: int32
        previous:
          type:
          - integer
          - 'null'
          format: int32
        next:
          type:
          - integer
          - 'null'
          format: int32
        last:
          type:
          - integer
          - 'null'
          format: int32
        totalRecords:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    PaginatedAccountsResponse:
      type: object
      properties:
        pagedData:
          $ref: '#/components/schemas/PagedData'
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountDto'
      additionalProperties: false
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/safe-external/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)