Dossier Segments

A Dossier Segment has a zero-to-one relationship with accommodation dossiers, transport dossiers, place dossiers and activity dossiers

Fields

Name

Type

Description

id (read-only)

String

href (read-only)

Field

label (required)

String

Contains the label for dossier segment

code (required)

String

number_of_children (read-only)

Integer

A count of the number of children on the segment

level (read-only)

Integer

The level of the tree the dossier segment sits at

description (required)

String

Long description of this detail type

parent (required)

Nested Object

Parent dossier_segments of this segment

  • id (read-only)

String

  • href (read-only)

Field

  • label (required)

String

Contains the label for dossier segment parent

  • code (required)

String

  • number_of_children (read-only)

Integer

A count of the number of children on the segment

  • level (read-only)

Integer

The level of the tree the dossier segment sits at

children (required)

Field

Child dossier segment of this segment

  • id (read-only)

String

  • href (read-only)

Field

  • label (required)

String

Contains the label for dossier segment child

  • code (required)

String

  • number_of_children (read-only)

Integer

A count of the number of children on the segment

  • level (read-only)

Integer

The level of the tree the dossier segment sits at

Get a Dossier Segment

GET /dossier_segments/(string: dossier_segment_id)

List Dossier Segments

GET /dossier_segments