openapi: 3.0.1
info:
  title: Businessapi-businessengagements
Engagements API   contact: {}
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  version: "1.0"
servers:
- url: https://api-test.sundsvall.se/businessengagements/sandbox/1.0/
tags:
- name: Business Engagements
  description: En tjänst som hämtar en persons företagsengagemang
paths:
  /engagements/{partyId}:
    get:
      tags:
      - Business Engagements
      operationId: getEngagements
      parameters:
      - name: partyId
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier for a person
          example: 6a5c3d04-412d-11ec-973a-0242ac130003
      - name: personalName
        in: query
        required: true
        schema:
          type: string
          description: The first and surname of the person
      - name: serviceName
        in: query
        required: true
        schema:
          type: string
          description: Name of the system initiating the request
          example: Mina Sidor
      responses:
        "500200":
          description: InternalSuccessful Server ErrorOperation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemBusinessEngagementsResponse'
        "200204":
          description: SuccessfulNo OperationContent
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessEngagementsResponse'
        "204404":
          description: NoNot ContentFound
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BusinessEngagementsResponseProblem'
        "400":
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Problem'
        "404500":
          description: NotInternal Server FoundError
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Problem'
components:   schemas/api-docs:
    Problemget:
      typetags:
object      - properties:API
        instancesummary: OpenAPI
         typeoperationId: stringgetApiDocs
          formatresponses:
uri         type"200":
          typedescription: stringOK
          formatcontent:
uri         parameters:   application/yaml:
       type: object       schema:
   additionalProperties:             type: objectstring
        statusx-auth-type: None
      x-throttling-tier: Unlimited
 $ref: '#/components/schemas/StatusType'    x-wso2-mutual-ssl: Optional
components:
  titleschemas:
    BusinessEngagementsResponse:
     type required:
 string     - status
  detail:    type: object
      typeproperties:
string      StatusType  engagements:
      type:  object  type: array
   properties:       items:
 reasonPhrase:           type$ref: string'#/components/schemas/Engagement'
        statusCodestatusDescriptions:
          type: integerobject
          formatadditionalProperties:
int32     BusinessEngagementsResponse:       requiredtype:  string
    - status       typedescription: object"In case fetching one or more engagement properties:failed, this will\
      engagements:        \ show why type:it arrayfailed. There may be more than one description if several\
 items:             $ref: '#/components/schemas/Engagement'
\ engagements failed."
       statusDescriptions:     example: Timeout
    type: object           additionalProperties:
            type: string
            description: "description: "In case fetching one or more engagement failed, this will\
 
            \ show why it failed. There may be more than one description if several\
 
            \ engagements failed."
            example: Timeout
        status:
 description: "In case fetching one or more engagement failed, this will\
         type: string
          description: If fetching all engagements went "OK" or "NOK". A "NOK" may
            still return engagements but indicates that the information is incomplete.
          example: OK
          enum:
          - OK
          - NOK
    Engagement:
      type: object
      properties:
        organizationName:
          type: string
          description: Name of the organization
          example: Styrbjörns båtar
        organizationNumber:
          type: string
          description: "Organization number, may also be personal number in case of\
       \ show why it failed. There\ mayenskild befirma"
more than one description if several\     example: "2021005448"
      \ engagements failed."organizationId:
          exampletype: string
 Timeout         statusdescription: Unique id for the organization (UUID)
      type: string   example: bab17d8b-af38-4531-967c-083f15ca1571
      description: Represents Ifa fetchingpersons allbusiness engagementsengagement.
went "OK" or "NOK". A "NOK" may Problem:
      type: object
      stillproperties:
return engagements but indicates that the information is incomplete.instance:
          exampletype: OKstring
          enumformat: uri
        type:
- OK         type: string
- NOK     Engagement:    format: uri
 type: object       propertiesparameters:
        organizationName:  type:  object
      type: string   additionalProperties:
       description: Name of the organization type: object
        examplestatus:
Styrbjörns båtar         organizationNumber$ref: '#/components/schemas/StatusType'
         typetitle:
string           descriptiontype: "Organizationstring
number, may also be personal number in case of\detail:
          type:  \string
enskild firma"    StatusType:
      exampletype: "2021005448"object
        organizationIdproperties:
        statusCode:
 type: string         type: integer
description: "Unique id for the organization (UUID), NOT implemented yet!" format: int32
        examplereasonPhrase: "2021005448"
      description: Represents a persons businesstype: engagement.string
  securitySchemes: {}

{
	"partyId": "6a5c3d04-412d-11ec-973a-0242ac130003",
	"personalName": "Jane Doe",
	"serviceName": "Kommunen"
}

{
    "engagements": [
        {
            "organizationName": "Fritjofs blommor och blad",
            "organizationNumber": "5561234567",
            "organizationId": " 793afd03-3be5-4e14-863f-a61d4859841d"
        },
        {
            "organizationName": "Vanja Jumpers plåt",
            "organizationNumber": "5561234568"
        }
    ]
    "statusDescriptions": {
      "5561234568": "Couldn't fetch guid for organization number"
    },
    "status": "NOK"
}