Telenor Sverige Contact Details API

openapi: 3.2.0
info:
  title: Geographic Sites Management Contact Details API
  description: 'The Geographic Sites Management API provides a standardized mechanism

    for managing geographic sites and their details.

    The API consists of a simple set of operations that interact with backend systems in a consistent manner.


    It is assumed that the reader is familiar with software API

    concepts such as REST, JSON and the OpenAPI specification.

    For more information about OpenAPI see OpenAPI Specification.


    ### Response Codes


    This API follows standard response codes defined in the

    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: 4.2.12
servers:
- url: https://apis-test.telenor.se/corporate/geographicSiteManagement
  description: Test environment
tags:
- name: Contact Details
  description: Endpoints for managing site contact details.
paths:
  /corporate/geographicSiteManagement/v1/site/contact/{contactId}:
    put:
      tags:
      - Contact Details
      summary: Updates a contact details
      operationId: PUT/v1/site/contact/{contactId}
      parameters:
      - name: contactId
        in: path
        description: The unique identifier of a contact person.
        required: true
        schema:
          type: string
          description: The unique identifier of a contact person.
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactRequest'
        required: true
      responses:
        '204':
          description: Successful invocation
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
      x-operation-id-source: normalized
      x-operation-id-original: PUT /v1/site/contact/{contactId}
    patch:
      tags:
      - Contact Details
      summary: Updates a contact details. Implements JSON Patch
      operationId: PATCH/v1/site/contact/{contactId}
      parameters:
      - name: contactId
        in: path
        description: The unique identifier of a contact person.
        required: true
        schema:
          type: string
          description: The unique identifier of a contact person.
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The JSON Patch document.
              items:
                $ref: '#/components/schemas/PatchOperation'
        required: true
      responses:
        '204':
          description: Successful invocation
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
      x-operation-id-source: normalized
      x-operation-id-original: PATCH /v1/site/contact/{contactId}
  /corporate/geographicSiteManagement/v1/site/contact:
    post:
      tags:
      - Contact Details
      summary: Adds a contact details to sites
      operationId: POST/v1/site/contact
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AddContactRequest'
        required: true
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AddContactResponse'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
      x-operation-id-source: normalized
      x-operation-id-original: POST /v1/site/contact
    delete:
      tags:
      - Contact Details
      summary: Deletes contact details from sites
      operationId: DELETE/v1/site/contact
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteContactRequest'
        required: true
      responses:
        '204':
          description: Successful invocation
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
      x-operation-id-source: normalized
      x-operation-id-original: DELETE /v1/site/contact
  /corporate/geographicSiteManagement/v1/site/contact/link:
    post:
      tags:
      - Contact Details
      summary: Links an existing contact to a site
      operationId: POST/v1/site/contact/link
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkContactToSiteRequest'
        required: true
      responses:
        '204':
          description: Successful invocation
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
      x-operation-id-source: normalized
      x-operation-id-original: POST /v1/site/contact/link
  /corporate/geographicSiteManagement/v1/site/contacts:
    get:
      tags:
      - Contact Details
      summary: Lists all contacts for all geographical sites for the account
      operationId: GET/v1/site/contacts
      parameters:
      - name: email
        in: query
        description: The e-mail address of a contact person to filter by.
        required: false
        schema:
          type: string
          description: The e-mail address of a contact person to filter by.
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        example: 5564210309
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactResponse'
      x-operation-id-source: normalized
      x-operation-id-original: GET /v1/site/contacts
components:
  schemas:
    SiteInfo:
      type: object
      description: The information about a site the contact is attached to.
      properties:
        siteId:
          type: string
          description: The ID of the site.
          example: 6172314
        siteRole:
          type: string
          description: The role of the site.
          example: Equipment
        contactRole:
          type: string
          description: The role of the contact on this site.
          example: Local Contact
    LinkContact:
      type: object
      properties:
        contactId:
          type: string
          description: The ID of the contact to be linked.
          example: C1263240
          minLength: 1
        role:
          type: string
          description: The role of the contact to be linked.
          enum:
          - LOCAL_CONTACT
          - TECHNICAL
          - PLANNED_WORK
          - ALARM_CONTACT
          example: Technical
      required:
      - contactId
      - role
    JsonNode: {}
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: The reason that caused the error.
          example: The provided site does not exist.
        code:
          type: string
          description: An application specific error code to differentiate error responses.
          enum:
          - MISSING_REQUIRED_PARAMETER
          - MISSING_AUTHORIZATION_HEADER
          - MISSING_AGREEMENT_IN_CAS
          - INVALID_INPUT
          - MISSING_ACCOUNT
          - UNAUTHORIZED_HEADER_USAGE
          - URL_NOT_FOUND
          - METHOD_NOT_SUPPORTED
          - NON_EXISTING_SITE
          - NON_EXISTING_CONTACT_ID
          - CONTACT_LINK_FAILURE
          - CONTACT_CREATION_FAILURE
          - UNAUTHORIZED
          - INTERNAL_ERROR
          example: MISSING_REQUIRED_PARAMETER
        timestamp:
          type: integer
          format: int64
          description: The date and time using the epoch standard of when the error occurred.
          example: 1615292025
    PatchOperation:
      type: object
      description: The JSON Patch document.
      properties:
        op:
          type: string
          minLength: 1
        path:
          type: string
          minLength: 1
        value:
          $ref: '#/components/schemas/JsonNode'
      required:
      - op
      - path
    AddContactResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the contact person.
          example: C1263231
        role:
          type: string
          description: The role of the contact person.
          enum:
          - LOCAL_CONTACT
          - TECHNICAL
          - PLANNED_WORK
          - ALARM_CONTACT
          example: TECHNICAL
        firstName:
          type: string
          description: The first name of the contact person.
          example: Jane
        lastName:
          type: string
          description: The last name of the contact person.
          example: Doe
        phoneNumber:
          type: string
          description: The phone number of the contact person.
          example: 4550000000
        mobileNumber:
          type: string
          description: The mobile number of the contact person.
          example: 0790000000
        email:
          type: string
          description: The email address of the contact person.
          example: jane.doe@example.se
    ContactResponse:
      type: object
      properties:
        contactId:
          type: string
          description: The unique identifier of a contact.
          example: C312351
        firstName:
          type: string
          description: The first name of the contact person.
          example: Jane
        lastName:
          type: string
          description: The last name of the contact person.
          example: Doe
        phone:
          type: string
          description: The phone number of the contact person.
          example: 4550000000
        mobilePhone:
          type: string
          description: The mobile number of the contact person.
          example: 0790000000
        email:
          type: string
          description: The email address of the contact person.
          example: jane.doe@example.se
        associatedSites:
          type: array
          description: The list of all sites the contact is attached to.
          items:
            $ref: '#/components/schemas/SiteInfo'
    AddContactRequest:
      type: object
      properties:
        role:
          type: string
          description: The role of the contact person.
          enum:
          - LOCAL_CONTACT
          - TECHNICAL
          - PLANNED_WORK
          - ALARM_CONTACT
          example: TECHNICAL
        firstName:
          type: string
          description: The first name of the contact person.
          example: Jane
          maxLength: 30
          minLength: 0
        lastName:
          type: string
          description: The last name of the contact person.
          example: Doe
          maxLength: 30
          minLength: 0
        phoneNumber:
          type: string
          description: The phone number of the contact person. Phone number should consist only of digits, spaces, dashes with optional leading plus. If missing the value of 'mobileNumber' will be used.
          example: 4550000000
        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
          minLength: 1
        email:
          type: string
          format: email
          description: The email address of the contact person.
          example: jane.doe@example.se
          minLength: 1
        siteIds:
          type: array
          items:
            type: string
            description: The list of site IDs to which the contact should be added.
            example: 345234
          minItems: 1
      required:
      - email
      - firstName
      - lastName
      - mobileNumber
      - role
      - siteIds
    DeleteContactRequest:
      type: object
      properties:
        contactIds:
          type: array
          items:
            type: string
            description: The IDs of the contacts to be removed.
            example: C1263240
          minItems: 1
        siteIds:
          type: array
          items:
            type: string
            description: The IDs of the sites from where the contact should be removed.
            example: 617234
          minItems: 1
      required:
      - contactIds
      - siteIds
    UpdateContactRequest:
      type: object
      properties:
        firstName:
          type: string
          description: The first name of the contact person.
          example: Jane
          maxLength: 30
          minLength: 0
        lastName:
          type: string
          description: The last name of the contact person.
          example: Doe
          maxLength: 30
          minLength: 0
        email:
          type: string
          format: email
          description: The email address of the contact person.
          example: jane.doe@example.se
          minLength: 1
        phoneNumber:
          type: string
          description: 'The phone number of the contact person. Phone number should consist only of digits, spaces, dashes with optional leading plus. '
          example: 4550000000
        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
          minLength: 1
      required:
      - email
      - firstName
      - lastName
      - mobileNumber
    LinkContactToSiteRequest:
      type: object
      properties:
        siteId:
          type: string
          description: The ID of an existing site.
          example: 6010417
          minLength: 1
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/LinkContact'
            description: The IDs of the contacts to be linked.
            example: C1263240
          minItems: 1
      required:
      - contacts
      - siteId
x-tagGroups:
- name: API Operations
  tags:
  - Geographic Sites
  - Contact Details
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/geographic-sites-management/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)