openapi: 3.0.1 info: title: Pensjon Samordningspliktige Hendelser description: "Hendelseskø for samordningspliktige hendelser (AP og AFP)\n\nPåkrevd scope-verdi: `nav:pensjon/v1/samordning`" version: '1.0' servers: - url: https://api.nav.no/pensjon/v1/samordning paths: /hendelser: get: tags: - Hendelser summary: Hendelser description: "Endepunktet returnerer en feed som inneholder hendelser tilhørende et angitt tjenestepensjonsnummer.\n\nFeeden benytter paginering, som deler opp feeden i sider basert på angitt antall hendelser per side. Hver side inneholder en liste med _hendelser_, samt en _nextUrl_ som peker til neste side av feeden. Siste side er nådd når _nextUrl_ er _null_.\n\nSekvensnummer kan benyttes som offset for feeden. Hendelser knyttet til et tjenestepensjonsnummer starter med sekvensnummer 1 til og med _sisteSekvensnummer_." operationId: HendelserGet parameters: - name: tpnr in: query description: Tjenestepensjonsnummer som vedtaket tilhører required: true schema: type: string - name: sekvensnummer in: query description: Start innlesningen fra dette sekvensnummeret schema: type: integer default: 1 - name: antall in: query description: Antall hendelser per side schema: type: integer default: 10000 - name: side in: query description: Sidenummer schema: type: integer default: 0 - name: Authorization in: header description: 'Standard Authorization-header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av ID-Porten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.' required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Feed' example: hendelser: - identifikator: string fom: string tom: string vedtakId: string samId: string ytelsesType: string sisteLesteSekvensnummer: 0 sisteSekvensnummer: 0 nextUrl: string '401': description: Ugyldig access token eller mangel på forhold mellom orgnr og tpnr content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/HendelserGet401ApplicationJson-charset-UTF-8Response' '403': description: Forbidden content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/HendelserGet403ApplicationJson-charset-UTF-8Response' '404': description: Not Found content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/HendelserGet404ApplicationJson-charset-UTF-8Response' '500': description: Internal Server Error content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/HendelserGet500ApplicationJson-charset-UTF-8Response' components: schemas: Feed: title: Feed type: object properties: hendelser: type: array items: $ref: '#/components/schemas/Hendelse' description: Liste av hendelser sisteLesteSekvensnummer: type: integer description: Siste sekvensnummer fra forrige side sisteSekvensnummer: type: integer description: Det nyeste sekvensnummeret nextUrl: type: string description: Lenke til neste side Hendelse: title: Hendelse type: object properties: identifikator: type: string description: Identifiserer brukeren (eks. fnr/dnr) fom: type: string description: Dato fra og med format: date tom: type: string description: Dato til og med format: date vedtakId: type: string description: Identifiserer vedtak i Pesys samId: type: string description: Samordning id tilknyttet vedtaket ytelsesType: type: string description: Ytelsestypen HendelserGet401ApplicationJson-charset-UTF-8Response: { } HendelserGet403ApplicationJson-charset-UTF-8Response: { } HendelserGet404ApplicationJson-charset-UTF-8Response: { } HendelserGet500ApplicationJson-charset-UTF-8Response: { } securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ] tags: - name: Hendelser description: ''