Telenor Sverige Sites API

openapi: 3.2.0
info:
  title: managing Fixed Network Install Base Sites 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: Sites
paths:
  /v1/accounts/{accountObjectId}/sites/{siteObjectId}:
    get:
      tags:
      - Sites
      summary: Gets a site by its unique objectId and selected account
      operationId: GET_v1/accounts/{accountObjectId}/sites/{siteObjectId}
      parameters:
      - name: accountObjectId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: siteObjectId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteDto'
  /v1/accounts/{accountObjectId}/sites:
    get:
      tags:
      - Sites
      summary: Lists sites for the specific account
      operationId: GET_v1/accounts/{accountObjectId}/sites
      parameters:
      - name: accountObjectId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSitesResponse'
components:
  schemas:
    SiteDto:
      title: Site
      type: object
      properties:
        objectId:
          type: integer
          description: Unique identifier for the site
          format: int64
        siteId:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
          description: The name of the site
        externalId:
          type:
          - string
          - 'null'
          description: Represents a external site id, could be supplied from the customer
        status:
          $ref: '#/components/schemas/EntityStatus'
        type:
          $ref: '#/components/schemas/SiteType'
        role:
          $ref: '#/components/schemas/SiteRole'
        address:
          $ref: '#/components/schemas/AddressDto'
      additionalProperties: false
      description: Represent a site or location. An account can have one or several sites.
    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
    PaginatedSitesResponse:
      type: object
      properties:
        pagedData:
          $ref: '#/components/schemas/PagedData'
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SiteDto'
      additionalProperties: false
    SiteRole:
      enum:
      - Undefined
      - Billing
      - Equipment
      - Legal
      - OWNER
      - Other
      type: string
      description: Represents the role of the site such as Billing- or Equipment site
    EntityStatus:
      enum:
      - Active
      - Inactive
      - Obsolete
      type: string
      description: Represents the status of a number of resources such Accounts, Sites, etc.
    SiteType:
      enum:
      - Undefined
      - Business
      - Office
      - Reseller
      - Individual
      - Vendor
      type: string
      description: Represents the type of the site such as Office- or Reseller site
    AddressDto:
      title: Address
      type: object
      properties:
        objectId:
          type: integer
          description: Unique identifier for the address
          format: int64
        street:
          type:
          - string
          - 'null'
          description: Primary street address (e.g., 'Storgatan')
        street2:
          type:
          - string
          - 'null'
          description: Additional street information, if needed
        street3:
          type:
          - string
          - 'null'
          description: Additional street information, if needed
        street4:
          type:
          - string
          - 'null'
          description: Additional street information, if needed
        streetName:
          type:
          - string
          - 'null'
          description: Name of the street (separated from the house number)
        streetNumber:
          type:
          - string
          - 'null'
          description: House or building number
        zipcode:
          type:
          - string
          - 'null'
          description: Postal code for the address
        city:
          type:
          - string
          - 'null'
          description: Name of the city or locality
        state:
          type:
          - string
          - 'null'
          description: The state for the specified address
        countryName:
          type:
          - string
          - 'null'
      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)