Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

Generiskt API mot kommunens e-arkiv.

  • Arkivera ärenden och dokument (POST)

Livscykelstatus

Produktion

Lösningsbeskrivning

Gliffy
imageAttachmentIdatt201129985
macroId3aba4daa-5d75-4ae8-9d6c-ab5817d41214
baseUrlhttps://sundsvall.atlassian.net/wiki
namearchive-API
diagramAttachmentIdatt201097217
containerId200605697
timestamp1647873884893

Hantering av personuppgifter

Inga personuppgifter hanteras i tjänsten.

API specifikation

Expand
titleAPI-nyckel för sandbox-miljö. Klicka på "Authorize" nedan och ange denna nyckel för att testa API:et.

eyJ4NXQiOiJNell4TW1Ga09HWXdNV0kwWldObU5EY3hOR1l3WW1NNFpUQTNNV0kyTkRBelpHUXpOR00wWkdSbE5qSmtPREZrWkRSaU9URmtNV0ZoTXpVMlpHVmxOZyIsImtpZCI6Ik16WXhNbUZrT0dZd01XSTBaV05tTkRjeE5HWXdZbU00WlRBM01XSTJOREF6WkdRek5HTTBaR1JsTmpKa09ERmtaRFJpT1RGa01XRmhNelUyWkdWbE5nX1JTMjU2IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhdXQiOiJBUFBMSUNBVElPTiIsImF1ZCI6IlZWTWlkM2tYemlCdWR6Qzl2ZjZtbWdCSDd1TWEiLCJuYmYiOjE2NDc4NTM2MTgsImF6cCI6IlZWTWlkM2tYemlCdWR6Qzl2ZjZtbWdCSDd1TWEiLCJzY29wZSI6ImFtX2FwcGxpY2F0aW9uX3Njb3BlIGRlZmF1bHQiLCJpc3MiOiJodHRwczpcL1wvYXBpbS5hcGkuc3VuZHN2YWxsLnNlOjk0NDNcL29hdXRoMlwvdG9rZW4iLCJleHAiOjE2NDc4NTcyMTgsImlhdCI6MTY0Nzg1MzYxOCwianRpIjoiYzcyYjkxYWUtMzhhMC00MDIwLTliYjQtOTc4ODhmMTYwZmE3In0.hDY4iK1Zn-kCjWL8UkgxvaENcBgJpnGdeDWRqKZ6kTdZ-xV6fR_9QB317BypAkYOLGJBfmswELJk2SsPEpoKB7yEjXsbXmlG9D9HeXm32kS3ugUul09_QW7rlzfjrZXNGbwx0Vfsszw-gRxcDTdghKo50hA3tijnAgQt9lpD43lUoYefIj2ribU5CQPBwARbSI3-6ClGXOW7h0AxpuZPOlROECdVHnWhPXa1qWfcMWPKnf6rHwMWy_kwrt6Q_ga8sXGAv4C44unRu4nTX7C5fzT0ZkZNFncdGsCnqAxpQ7a9Y8yULknjWsE0U53qbVqQwbE-ATUygKD0qFnZPl3j4g

Swagger ui
openapi: 3.0.1
info:
  title: Archive
  contact: {}
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  version: "0.1"
servers:
- url: https://api-test.sundsvall.se/archive/
tags:
- name: Archive resources
paths:
  /archive/byggr:
    post:
      tags:
      - Archive resources
      summary: Submit a ByggR archive request
      operationId: byggR
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ByggRArchiveRequest'
        required: true
      responses:
        "200":
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ArchiveResponse'
        "400":
          description: Bad request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Problem'
  /api-docs:
    get:
      tags:
      - API
      summary: OpenAPI
      operationId: getApiDocs
      responses:
        "200":
          description: OK
          content:
            application/yaml:
              schema:
                type: string
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-mutual-ssl: Optional
security:
  - ApiKeyAuth: []
components:
  schemas:
    Attachment:
      required:
      - extension
      - name
      type: object
      properties:
        name:
          type: string
        extension:
          pattern: ^\.(bmp|gif|tif|tiff|jpeg|jpg|png|htm|html|pdf|rtf|doc|docx|txt|xls|xlsx|odt|ods)$
          type: string
          example: .pdf
        file:
          type: string
          description: BASE64-encoded file contents
          example: YXBhCg==
      description: Bilaga
    ByggRArchiveRequest:
      required:
      - attachment
      - metadata
      type: object
      properties:
        attachment:
          $ref: '#/components/schemas/Attachment'
        metadata:
          type: string
          description: Metadata XML
      description: Request för att arkivera bygglovshandlingar
    ArchiveResponse:
      type: object
      properties:
        archiveId:
          type: string
          description: Archive ID
          nullable: true
        errorDetails:
          $ref: '#/components/schemas/ErrorDetails'
      description: Archive response
    ErrorDetails:
      type: object
      properties:
        errorCode:
          type: integer
          description: Formpipe error code
          format: int32
        errorMessage:
          type: string
          description: Formpipe error message
        serviceName:
          type: string
          description: Formpipe service name
          nullable: true
      description: Error details
      nullable: true
    Problem:
      type: object
      properties:
        instance:
          type: string
          format: uri
        type:
          type: string
          format: uri
        parameters:
          type: object
          additionalProperties:
            type: object
        status:
          $ref: '#/components/schemas/StatusType'
        title:
          type: string
        detail:
          type: string
    StatusType:
      type: object
      properties:
        reasonPhrase:
          type: string
        statusCode:
          type: integer
          format: int32
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey

Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth 2

Teknisk ägare

https://sundsvall.atlassian.net/wiki/spaces/API

För tekniska frågor:
teamdynasty@sundsvall.se

Källkod

<TBD>

FAQ

<FAQ>