Grensesnittbeskrivelse
For å bruke grensesnittet kreves autentisering med X.509-sertifikat.
URL har følgede oppbygging:
GET https://<env>/api/fastsetting/oppgaveinnlevering/<organisasjonsnummer>/?fraDato=<fraDato>
<env>: Miljø-spesifikk adresse<organisasjonsnummer>: Organisasjonsnummeret man spør etter informasjon om.<fraDato>: Skal være på formatet åååå-mm-dd
Støttetjenester
Hendelsesliste
For å følge med på endringer i Oppgaveinnlevering tilbyr vi en hendelsesliste. URL er:
GET https://<env>/api/fastsetting/oppgaveinnlevering/hendelser/
Versjonering
Se generelle regler for versjonering.
Eksempel på respons fra tjenesten
Her er et eksempel på en spørring med curl mot tjenesten. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.
$ curl -v --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/fastsetting/oppgaveinnlevering/012345678?fraDato=2018-01-01"
Suksess (HTTP status 200)
Dersom kallet lykkes får man HTTP status 200 og data i JSON
JSON
[
{
"organisasjonsnummer": "912470806",
"omsetningsoppgave": [
{
"oppgavetermin": {
"start": "2014-11-01",
"slutt": "2014-12-31",
"forfallsdato": "2015-02-10"
},
"innkomstdato": "2015-06-15"
},
{
"oppgavetermin": {
"start": "2015-01-01",
"slutt": "2015-02-28",
"forfallsdato": "2015-04-10"
},
"innkomstdato": "2015-04-09"
},
{
"oppgavetermin": {
"start": "2016-03-01",
"slutt": "2016-04-30",
"forfallsdato": "2016-06-10"
},
"innkomstdato": "2016-08-31"
},
{
"oppgavetermin": {
"start": "2017-05-01",
"slutt": "2017-06-30",
"forfallsdato": "2017-08-31"
},
"innkomstdato": "2017-08-31"
},
{
"oppgavetermin": {
"start": "2018-07-01",
"slutt": "2018-08-31",
"forfallsdato": "2018-10-12"
},
"innkomstdato": "2018-10-12"
},
{
"oppgavetermin": {
"start": "2018-09-01",
"slutt": "2018-10-31",
"forfallsdato": "2018-12-10"
},
"innkomstdato": "2018-12-08"
},
{
"oppgavetermin": {
"start": "2019-11-01",
"slutt": "2019-12-31",
"forfallsdato": "2019-02-10"
}
},
{
"oppgavetermin": {
"start": "2019-03-01",
"slutt": "2019-04-30",
"forfallsdato": "2019-05-30"
}
}
]
}
]
Feilmeldinger (HTTP status ikke 200)
Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.
JSON
{
"kode": "OPPGAVEINNLEVERING-06",
"melding": "Ingen oppgaveinnleveringer funnet",
"korrelasjonsid": "13a865f5-28f9-47db-9abd-ab78977c79fe"
}
Feilkoder
Se også felles feilkoder for alle applikasjonene.
| HTTP status | Feilkode | Feilmelding |
|---|---|---|
| 400 | OPPGAVEINNLEVERING-00 | Det påkrevde feltet ‘organisasjonsnummer’ mangler. |
| 400 | OPPGAVEINNLEVERING-01 | Det påkrevde feltet ‘fraDato’ mangler. |
| 400 | OPPGAVEINNLEVERING-02 | Feltet ‘organisasjonsnummer’ er ugyldig. Det må inneholde nøyaktig 9 tall. |
| 400 | OPPGAVEINNLEVERING-03 | Feltet ‘fraDato’ er ugyldig. Det må følge ‘yyyy-mm-dd’ |
| 401 | OPPGAVEINNLEVERING-04 | Autentisering feilet |
| 403 | OPPGAVEINNLEVERING-05 | Du er ikke autorisert for bruk av dette endepunktet. |
| 404 | OPPGAVEINNLEVERING-06 | Ingen oppgaveinnleveringer funnet |
| 500 | OPPGAVEINNLEVERING-07 | Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte! |
| 500 | OPPGAVEINNLEVERING-08 | Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte! øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte! |
Miljøer
| Miljø | URL |
|---|---|
| Akseptansetest (AT) | https://api-at.sits.no |
| Produksjon (Prod) | https://api.skatteetaten.no |
Ønsker du å komme i kontakt med oss for spørsmål eller andre henvendelser, se veiledning på Skatteetaten.no.