day-types

Server

Download schema

Retrieves all day types

GET

https://api.entur.io/products

/day-types

Retrieves all day types › query Parameters

orgId

string · style: form · explode: true

fareFrameId

string · style: form · explode: true

minimizeDataLoad

boolean · style: form · explode: true

validOnDate

string · date-time · style: form · explode: true

Return only the versions valid on the given date (ISO-8601).

Retrieves all day types › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves all day types › Responses

Returns the info

DayType[]

The DayType describe during which the assignment applies

DayType

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

TextInLanguage[]

Description of day type

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

earliestTime

string

Earliest time.

Example: 11:11:11

TextInLanguage[]

Name of day type

PropertyOfDay[]

Properties of day

VersionOfObjectRef[]

Time band references.

GET/day-types

curl https://api.entur.io/products/day-types

Example Responses

[
  {
    "changed": "changed",
    "created": "created",
    "dayLength": "PT04H",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "durationAfterPropertiesOfDay": "PT7H",
    "durationBeforePropertiesOfDay": "PT24H",
    "earliestTime": "11:11:11",
    "id": "ENT:DayType:BicycleFlatFare",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "DayType",
    "properties": [
      {
        "countryRef": "NO",
        "dayOfYear": "01-25",
        "daysOfWeek": [
          "string"
        ],
        "description": "Days family discount is available",
        "holidayTypes": [
          "string"
        ],
        "monthOfYear": 0,
        "name": "Monday"
      }
    ],
    "status": "DRAFT",
    "timebandRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "version": "NSB:Version:V1"
  }
]

text

*/*

Create a dayType

POST

https://api.entur.io/products

/day-types

Create a dayType › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create a dayType › Request Body

The DayType describe during which the assignment applies

DayType

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

TextInLanguage[]

Description of day type

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

earliestTime

string

Earliest time.

Example: 11:11:11

TextInLanguage[]

Name of day type

PropertyOfDay[]

Properties of day

VersionOfObjectRef[]

Time band references.

Create a dayType › Responses

Entity created successfully

No data returned

POST/day-types

curl https://api.entur.io/products/day-types \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves the day type valid on a given date

GET

https://api.entur.io/products

/day-types/{id}

Optional validOnDate query parameter (defaults to now). In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieves the day type valid on a given date › path Parameters

id

string · required · style: simple

The id to identify a DayType

Retrieves the day type valid on a given date › query Parameters

validOnDate

string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601).

Retrieves the day type valid on a given date › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves the day type valid on a given date › Responses

Returns the info

The DayType describe during which the assignment applies

DayType

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

TextInLanguage[]

Description of day type

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

earliestTime

string

Earliest time.

Example: 11:11:11

TextInLanguage[]

Name of day type

PropertyOfDay[]

Properties of day

VersionOfObjectRef[]

Time band references.

GET/day-types/{id}

curl https://api.entur.io/products/day-types/:id

Example Responses

{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}

text

*/*

Retrieves day type for id and version

GET

https://api.entur.io/products

/day-types/{id}/{version}

Retrieves day type for id and version › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id to identify a DayType

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id for the version of the DayType

Retrieves day type for id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves day type for id and version › Responses

Returns the info

The DayType describe during which the assignment applies

DayType

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

TextInLanguage[]

Description of day type

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

earliestTime

string

Earliest time.

Example: 11:11:11

TextInLanguage[]

Name of day type

PropertyOfDay[]

Properties of day

VersionOfObjectRef[]

Time band references.

GET/day-types/{id}/{version}

curl https://api.entur.io/products/day-types/:id/:version

Example Responses

{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}

text

*/*

Updates an existing DayType

PUT

https://api.entur.io/products

/day-types/{id}/{version}

Updates an existing DayType › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id to identify a DayType

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id for the version of the DayType

Updates an existing DayType › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Updates an existing DayType › Request Body

The DayType describe during which the assignment applies

DayType

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: ENT:DayType:BicycleFlatFare

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · readOnly · required

Name of class.

Example: DayType

status

string · enum · readOnly · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version.

Example: NSB:Version:V1

dayLength

string

Day length. Represented as a string formatted according to ISO-8601

Example: PT04H

TextInLanguage[]

Description of day type

durationAfterPropertiesOfDay

string

Duration after properties of day. Represented as a string formatted according to ISO-8601

Example: PT7H

durationBeforePropertiesOfDay

string

Duration before properties of day. Represented as a string formatted according to ISO-8601

Example: PT24H

earliestTime

string

Earliest time.

Example: 11:11:11

TextInLanguage[]

Name of day type

PropertyOfDay[]

Properties of day

VersionOfObjectRef[]

Time band references.

Updates an existing DayType › Responses

Entity updated successfully

No data returned

PUT/day-types/{id}/{version}

curl https://api.entur.io/products/day-types/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "changed": "changed",
  "created": "created",
  "dayLength": "PT04H",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "durationAfterPropertiesOfDay": "PT7H",
  "durationBeforePropertiesOfDay": "PT24H",
  "earliestTime": "11:11:11",
  "id": "ENT:DayType:BicycleFlatFare",
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "DayType",
  "properties": [
    {
      "countryRef": "NO",
      "dayOfYear": "01-25",
      "daysOfWeek": [
        "string"
      ],
      "description": "Days family discount is available",
      "holidayTypes": [
        "string"
      ],
      "monthOfYear": 0,
      "name": "Monday"
    }
  ],
  "status": "DRAFT",
  "timebandRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Deletes an day type given by id and version

DELETE

https://api.entur.io/products

/day-types/{id}/{version}

Deletes an day type given by id and version › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id to identify a day type

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The id for the version of the day type

Deletes an day type given by id and version › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Deletes an day type given by id and version › Responses

The resource was deleted

BoxedUnit

companion-profiles distance-matrix-elements

Did you find what you were looking for?

day-types

Retrieves all day types

Retrieves all day types › query Parameters

Retrieves all day types › Headers

Retrieves all day types › Responses

Create a dayType

Create a dayType › Headers

Create a dayType › Request Body

Create a dayType › Responses

Retrieves the day type valid on a given date

Retrieves the day type valid on a given date › path Parameters

Retrieves the day type valid on a given date › query Parameters

Retrieves the day type valid on a given date › Headers

Retrieves the day type valid on a given date › Responses

Retrieves day type for id and version

Retrieves day type for id and version › path Parameters

Retrieves day type for id and version › Headers

Retrieves day type for id and version › Responses

Updates an existing DayType

Updates an existing DayType › path Parameters

Updates an existing DayType › Headers

Updates an existing DayType › Request Body

Updates an existing DayType › Responses

Deletes an day type given by id and version

Deletes an day type given by id and version › path Parameters

Deletes an day type given by id and version › Headers

Deletes an day type given by id and version › Responses

Build with Entur

Contribute

Terms & Policies