Entur Developer
Skoleskyss

PostSkoleskyssRequest

​NumberOrString · required
​NumberOrString · required
​ValidityRequest · required

endDate må være samme dag som eller etter startDate, og kan ikke ha passert.

organisationId
​number
name
​string

Navnet på skyssretten. For eksempel 'Skoleskort 2025-2026'.

schoolName
​string

Navnet på skolen

​StudentDetailsRequest

NumberOrString

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = string
type = number
Properties for Variant 1:
string · minLength: 1

ValidityRequest

endDate må være samme dag som eller etter startDate, og kan ikke ha passert.
startDate
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
endDate
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required
​Zone[] · required
name
​string

Navn på gyldigheten. Brukes i billettvisningen.

​

Må inneholde enten id eller validDates, ikke begge.

tripDurationMinutes
​integer · max: 9007199254740991

Antall minutter et enkelt klipp er gyldig etter aktivering. Standard er 180 minutter.

maxAvailableTrips
​integer · min: 0 · max: 9007199254740991

Maks antall turer totalt skyssretten gir rett til. Hvis utelatt er det ingen begrensning.

maxTripsPerDay
​integer · min: 1 · max: 10

Maks antall turer per dag skyssretten gir rett til. Standard er 2.

​object

Tidsvindu for når eleven kan gjennomføre turer. Overstyrer eventuell standard fra config. fromHour må være mindre enn eller lik toHour.

Zone

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: fromPrivateCode, toPrivateCode
type = object · requires: fromZoneId, toZoneId
type = object · requires: groupOfTariffZoneId
Properties for Variant 1:
​NumberOrString · required
​NumberOrString · required

PrivateCodeZone

​NumberOrString · required
​NumberOrString · required

FareZoneIds

fromZoneId
​string · pattern: ^[A-Z]{3}:FareZone:\… · required
toZoneId
​string · pattern: ^[A-Z]{3}:FareZone:\… · required

GroupOfTariffZone

groupOfTariffZoneId
​string · pattern: ^[A-Z]{3}:GroupOfTar… · required

StudentDetailsRequest

firstName
​string
surname
​string
​IdAndName
​IdAndName
email
​string · email · pattern: ^(?:[A-Za-z0-9_'+\-]…
​object

Ved landskode +47 må number starte med 4 eller 9 og bestå av 8 siffer.

IdAndName

​NumberOrString · required
name
​string · required

DeleteSkoleskyssRequest

​NumberOrString · required
​NumberOrString · required
organisationId
​number

PostSkoleskyssResponse

​object · required
​object · required
​TransferDetails

TravelRightOutcome

string · enum
Enum values:
created
replaced
unchanged

"created" = ny skyssrett. "replaced" = eksisterende skyssrett ble erstattet fordi noe var endret. "unchanged" = skyssretten var allerede lik forespørselen og ble beholdt; kun mottakeropplysninger ble oppdatert.

TransferDetails

pickupCode
​string · required
expiresAt
​string

ValidationIssue

code
​string · required
path
​(string | number)[] · required
message
​string · required

InvalidRequestError

Kastes ved ugyldig kalender (InvalidCalendarError) eller ukjent sone (PrivateCodeNotFoundZoneError).
error
​string · required
message
​string · required

InternalError

error
​string · const · required
Const value: Internal

DeleteSkoleskyssResponse

customerAccountId
​string · required
fareContractId
​string
Did you find what you were looking for?