Skip to content

EntryList

Types

controlCardEntry

A control card entry with rental information, as used in an EntryList.

rescript
type controlCardEntry = {
  card: IofXml.IofControlCard.t,
  rented: bool,
}

Fields:

  • card: IofXml.IofControlCard.t
  • rented: bool — Whether the control card is rented (not owned by the competitor).

personEntry

An event entry for a single person.

See: PersonEntry in the IOF XML 3.0 XSD

rescript
type personEntry = {
  id: option<string>,
  person: IofXml.IofPerson.t,
  organisations: array<IofXml.IofOrganisation.t>,
  controlCards: array<controlCardEntry>,
  className: option<string>,
  classId: option<string>,
  status: option<string>,
  startTimeAllocationRequest: option<string>,
  raceNumber: option<int>,
}

Fields:

  • id: option&lt;string&gt; — Entry identifier, if present.
  • person: IofXml.IofPerson.t
  • organisations: array&lt;IofXml.IofOrganisation.t&gt; — The organisations the person represents at the event.
  • controlCards: array&lt;controlCardEntry&gt;
  • className: option&lt;string&gt; — The name of the class the person is entered in.
  • classId: option&lt;string&gt; — The identifier of the class the person is entered in.
  • status: option&lt;string&gt; — The entry status, e.g. "Active" or "Cancelled".
  • startTimeAllocationRequest: option&lt;string&gt; — Any special preferences for start time allocation.
  • raceNumber: option&lt;int&gt; — The ordinal race number this entry applies to in a multi-race event, starting at 1.

t

A list of persons and/or teams registered for a particular event.

See: EntryList in the IOF XML 3.0 XSD

rescript
type t = {
  event: option<IofXml.IofEvent.t>,
  personEntries: array<personEntry>,
}

Fields:

  • event: option&lt;IofXml.IofEvent.t&gt;
  • personEntries: array&lt;personEntry&gt; — The individual competitors registered for the event.

Values

parsePersonEntry

rescript
let parsePersonEntry: IofXml.XmlUtils.xmlElement => option<personEntry>

parse

Parse an IOF XML 3.0 EntryList document string into a typed structure.

rescript
let parse: string => result<t, string>

serializePerson

rescript
let serializePerson: IofXml.IofPerson.t => string

serializeOrg

rescript
let serializeOrg: IofXml.IofOrganisation.t => string

serializeControlCard

rescript
let serializeControlCard: controlCardEntry => string

serializePersonEntry

rescript
let serializePersonEntry: personEntry => string

serializeEvent

rescript
let serializeEvent: IofXml.IofEvent.t => string

serialize

Serialize an EntryList structure to an IOF XML 3.0 document string.

rescript
let serialize: t => string