openapi: 3.0.1
info:
  title: FoundationObjects
  version: v1.0
servers:
  - url: https://api-test.sundsvall.se/fo/1.0
paths:
  /companies:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Company'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Company'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Company'
  /benefitgroups:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BenefitGroup'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BenefitGroup'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BenefitGroup'
  /formofemployments:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FormOfEmployment'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FormOfEmployment'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FormOfEmployment'
  /referencenumbers:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
  /companiesreferencenumbers:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferenceNumber'
  /units:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Unit'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Unit'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Unit'
  /externalcompanies:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExternalCompanyAddress'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExternalCompanyAddress'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExternalCompanyAddress'
  '/externalcompanies/{organisationnumber}':
    get:
      tags:
        - FoundationObjects
      parameters:
        - name: organisationnumber
          in: path
          required: true
          style: simple
          explode: false
          schema:
            type: string
            format: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ExternalCompanyAddress'
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCompanyAddress'
            text/json:
              schema:
                $ref: '#/components/schemas/ExternalCompanyAddress'
  /liabilities:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Liability'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Liability'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Liability'
  /operations:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Operation'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Operation'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Operation'
  /activities:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Activity'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Activity'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Activity'
  /projects:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
  /objects:
    get:
      tags:
        - FoundationObjects
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MunicipalityObject'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MunicipalityObject'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MunicipalityObject'
security:
  - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth: 
      type: apiKey
      in: header   
      name: apikey
  schemas:
    Company:
      type: object
      properties:
        companyId:
          type: integer
          format: int32
        companyCode:
          type: string
          nullable: true
        shortName:
          type: string
          nullable: true
        displayName:
          type: string
          nullable: true
        isSchool:
          type: boolean
        isPrivateSchool:
          type: boolean
      additionalProperties: false
    BenefitGroup:
      type: object
      properties:
        benefitGroupId:
          type: integer
          format: int32
        description:
          type: string
          nullable: true
      additionalProperties: false
    FormOfEmployment:
      type: object
      properties:
        foeId:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
      additionalProperties: false
    ReferenceNumber:
      type: object
      properties:
        id:
          type: integer
          format: int32
        companyCode:
          type: integer
          format: int32
        referenceNumber:
          type: string
          nullable: true
        referenceText:
          type: string
          nullable: true
      additionalProperties: false
    Unit:
      type: object
      properties:
        id:
          type: integer
          format: int32
        unit:
          type: string
          nullable: true
      additionalProperties: false
    ExternalCompanyAddress:
      type: object
      properties:
        id:
          type: integer
          format: int32
        companyName:
          type: string
          nullable: true
        addressLine1:
          type: string
          nullable: true
        addressLine2:
          type: string
          nullable: true
        addressLine3:
          type: string
          nullable: true
        counterpart:
          type: string
          nullable: true
        organizationNumber:
          type: string
          nullable: true
      additionalProperties: false
    Liability:
      type: object
      properties:
        id:
          type: integer
          format: int32
        liableId:
          type: string
          nullable: true
        liable:
          type: string
          nullable: true
      additionalProperties: false
    Operation:
      type: object
      properties:
        id:
          type: integer
          format: int32
        operationId:
          type: string
          nullable: true
        operation:
          type: string
          nullable: true
      additionalProperties: false
    Activity:
      type: object
      properties:
        id:
          type: integer
          format: int32
        activity:
          type: string
          nullable: true
      additionalProperties: false
    Project:
      type: object
      properties:
        id:
          type: integer
          format: int32
        project:
          type: string
          nullable: true
      additionalProperties: false
    MunicipalityObject:
      type: object
      properties:
        id:
          type: integer
          format: int32
        municipalityObject:
          type: string
          nullable: true
      additionalProperties: false