This page describes the messages that Data Providers should return when
responseDetails.status is partial.
A partial status indicates that additional data is available
in the Data Provider's systems but cannot be retrieved through the API.
The additional data may be retrieved manually.
When a response is partial, the Data Consumer needs information
about the reason for the status to inform the user and determine whether the
additional data should be requested from the Data Provider by digital letter.
Data Providers should therefore provide a precise explanation in
responseDetails.message.
Messages for partial responses
The table below lists the most common reasons for returning
partial and the corresponding messages that Data Providers should
return. The list is not exhaustive.
The messages are in Norwegian as they are intended to be displayed by Data
Consumers to their users. If several reasons apply to the same response, the
relevant Norwegian messages should be concatenated and returned as a single
text string in responseDetails.message. All descriptions should
be as precise as possible.
| Scenario | Message | Notes |
|---|---|---|
| Transaction data is not available online for the entire requested period. | «Transaksjonsopplysninger for perioden 01.01.2015 til 30.06.2016 er ikke tilgjengelig online og kan eventuelt innhentes via digitalt brev.» | The dates must reflect the requested period. |
| Account information is not available online for the entire requested period. | «Oversikt over kontoer for perioden 01.01.2015 til 30.06.2016 er ikke tilgjengelig online og kan eventuelt innhentes via digitalt brev.» | The dates must reflect the requested period. |
| The account is part of an account hierarchy (cash pool), and the relevant account details cannot be retrieved online. | «Konto xxxx.xx.xxxxx i listen er en konsernkonto og er en del av et kontohierarki (cash pool) og hverken kontodetaljer, transaksjoner, kort eller roller kan bli hentet online.» | The account number must reflect the relevant account in the account hierarchy. |
| Role information is not available online for the entire requested period. | «Oversikt over roller for perioden 01.01.2015 til 30.06.2016 er ikke tilgjengelig online og kan eventuelt innhentes via digitalt brev.» | The dates must reflect the requested period. |
| Card information is not available online for the entire requested period. | «Oversikt over kort knyttet til denne kontoen for perioden 01.01.2015 til 30.06.2016 er ikke tilgjengelig online og kan eventuelt innhentes via digitalt brev.» | The dates must reflect the requested period. |
Other reasons for returning partial.
|
No predefined message. |
Provide a clear and informative message in Norwegian that explains why
the response is partial.
|
References
| Reference | Document |
|---|---|
| [ACCOUNT-API] | Account API specification V.2.0 |
| [DATA-MODEL] | Data model - Description of API V.2.0 |
Change log
| Version | Date | Change |
|---|---|---|
| 1.0 | 08.02.2021 | Input from Skatteetaten concerning precise description and non-exhaustive list of reasons inserted in the introduction section. The document was accepted by the Control Project Group. |
| 1.1 | 14.08.2023 |
Minor change regarding how to use
responseDetails.message when Data Providers wish to inform
Data Consumers that several reasons for partial arise at
the same time.
|
| 2.0 | 06.03.2024 |
Harmonisation with DSOP Control API version 2.0.
responseStatus no longer exists in version 2.0 of the API,
and references to this field were removed. The previous chapter
concerning coexistence of responseDetails.status and
responseStatus = partial was also removed.
|