Skip to content

Commit

Permalink
norwegian translation for init summary
Browse files Browse the repository at this point in the history
  • Loading branch information
CelineTrammi committed Dec 12, 2024
1 parent 55182e1 commit 338c527
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ See [Authentication and Authorization](/notifications/reference/api/#authenticat

## Request

### Content type
### Content-Type

application/json

Expand All @@ -50,17 +50,17 @@ Type: _List\<string>_

List of recipients for the correspondence. This can either be the organization number or the national identity number of the recipient.

For *organization numbers*, the recipients must include the prefix `urn:altinn:organization:identifier-no` in front of the organization number.
For *organization numbers*, the recipients must include the prefix `urn:altinn:organization:identifier-no` in front of the organization number. Example `urn:altinn:organization:identifier-no:123456789`

For *national identity numbers*, the must have the prefix `urn:altinn:person:identifier-no` in front of the identity number.
For *national identity numbers*, the recipients must have the prefix `urn:altinn:person:identifier-no` in front of the identity number. Example `urn:altinn:person:identifier-no:01019912345`

### Optional request properties

#### existingAttachments

Type: _List\<string>_

List of attachment ID(s) for the attachment(s) which should be included with the correspondence(s). These must be uploaded using the attachment endpoint beforehand.
List of attachment ID(s) for the attachment(s) which should be included with the correspondence(s). These must be uploaded using the **attachment** endpoint beforehand.

## Response

Expand All @@ -77,7 +77,6 @@ List of attachment ID(s) for the attachment(s) which should be included with the

### Response body


The response body returns a list of correspondences [InitializeCorrespondencesResponseExt](https://github.com/Altinn/altinn-correspondence/blob/main/src/Altinn.Correspondence.API/Models/InitializeCorrespondencesResponseExt.cs), with one correspondence for each recipient.
Find a short description of each property below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,62 +21,69 @@ Dette endepunktet oppretter en melding og legger den i kø for sending. Før du

Dette API-et krever autentisering, og forespørselen må også inkludere:

- Correspondence write scope __altinn:correspondence.write__ (for eksterne kall)
- Correspondence write scope **altinn:correspondence.write** (for eksterne kall)

Se [Autentisering og Autorisasjon](/notifications/reference/api/#authentication--authorization) for mer informasjon.

## Request body

[Du kan se et eksempel på en request body her](https://docs.altinn.studio/api/correspondence/spec/#/Correspondence/post_correspondence_api_v1_correspondence)
### Content-Type (Innholdstype)

## Respons
- application/json

### Responskoder
### Request body

- 200 OK: Responsen har blitt vellykket initialisert
Request body må bestå av melding(er) i requesten på formatet i [InitializeCorrespondencesRequest](https://github.com/Altinn/altinn-correspondence/blob/main/src/Altinn.Correspondence.API/Models/InitializeCorrespondencesExt.cs)

Se problemdetaljer i responskroppen for mer informasjon.
- 401 Unauthorized: Indikerer en manglende, ugyldig eller utløpt autorisasjonsheader.
- 403 Forbidden: Indikerer at nødvendig omfang eller plattformtilgangstoken mangler eller er ugyldig.
### Påkrevde felter i requesten

### Innholdstype
#### correspondence

- application/json
Type: [BaseCorrespondenceExt](/correspondence/reference/api-endpoints/initialize/basecorrespondenceext/)

Meldingen(e) som skal opprettes.

#### recipients

### Response body
Type: _List\<string>_

Respons body returnerer en liste over meldinger [InitializeCorrespondencesResponseExt](https://github.com/Altinn/altinn-correspondence/blob/main/src/Altinn.Correspondence.API/Models/InitializeCorrespondencesResponseExt.cs), med en melding for hver mottaker. Hver melding kan ha flere forskjellige mottakere hvor hver mottaker vil få en unik correspondenceId, status, etc.
Liste of mottakere til meldingen(ene). Dette kan enten være organisasjonsnummer eller personnummer.

### Response body egenskaper
For _organisasjonsnummer_, er mottakerne nødt til å ha med prefiksen `urn:altinn:organization:identifier-no` foran organisasjonsnummeret. For eksempel "urn:altinn:organization:identifier-no:123456789"

#### correspondenceId
Type: _Guid_
For _personnummer_, the must have the prefix `urn:altinn:person:identifier-no` in front of the identity number. For eksempel "urn:altinn:person:identifier-no:01019912345"

ID-en til meldingen som har blitt initialisert
### Valgfrie felter i requesten

#### status
Type: _string_
#### existingAttachments

[De forskjellige statusene er definert her](https://github.com/Altinn/altinn-correspondence/blob/main/src/Altinn.Correspondence.API/Models/Enums/CorrespondenceStatusExt.cs)
Type: _List\<string>_

Liste med ID(er) til vedlegg(ene) som skal inkluderes med meldingen(e). Disse må lastes opp på forhånd ved å bruke **attachment** sitt endepunkt.

## Respons

### Responskoder

- 200 OK: Responsen har blitt vellykket initialisert
- 400 Bad Request: Requesten var ugyldig. Se problemdetaljer i responskroppen for mer informasjon.
- 401 Unauthorized: Indikerer en manglende, ugyldig eller utløpt autorisasjonsheader.
- 403 Forbidden: Indikerer at nødvendig omfang eller plattformtilgangstoken mangler eller er ugyldig.

Viser statusen til den initialiserte meldingen
### Content-Type (Innholdstype)

#### recipient
Type: _string_
application/json

Viser mottakeren i formatet 0192:{{recipientOrgNumber}}
### Response body

#### notifications
Type: _Liste over [InitializedCorrespondencesNotificationsExt](https://docs.altinn.studio/api/correspondence/spec/#/Correspondence/post_correspondence_api_v1_correspondence)_
Respons body returnerer en liste over meldinger [InitializeCorrespondencesResponseExt](https://github.com/Altinn/altinn-correspondence/blob/main/src/Altinn.Correspondence.API/Models/InitializeCorrespondencesResponseExt.cs), med en melding for hver mottaker.
Nedenfor er en kort beskrivelse av hver av feltene.

En liste over de genererte varslene med sendingsresultat. Hvert varsel vil inkludere følgende egenskaper:
#### correspondences
Type: [List\<InitializedCorrespondencesExt>](/correspondence/reference/api-endpoints/initialize/initializedcorrespondencesext/)

- _orderId_: ID-en til ordren.
- _isReminder_: en boolsk verdi som indikerer om varselet er en påminnelse eller ikke.
- _status_: viser statusen til varselet i det tidspunktet meldingen(e) ble opprettet.
Informasjon on meldingen(e) som ble opprettet.
#### attachmentIds
Type: _List\<Guid>_

| Status | Beskrivelse |
|:-----------------:|:---------------------------------------------------------------------------:|
| Success | Varselordren ble opprettet vellykket med kontaktinformasjon til __minst en__ av mottakerne til varslingen. |
| MissingContact | Kontaktinformasjon ble __ikke funnet for noen__ av mottakerne av varslingen. |
| Failure | Opprettelse av varselordre mislyktes på grunn av en feil. |
ID(ene) til vedleggene som ble inkludert med meldingen(e).

0 comments on commit 338c527

Please sign in to comment.