POST Api/TimeRegistration/V3/Start

Starts a timeregistration

Request Information

URI Parameters

None.

Body Parameters

TimeRegistrationModel
NameDescriptionTypeAdditional information
ID

integer

None.

DutyID

integer

None.

StartTime

date

None.

EndTime

date

None.

CommentStartedTooLate

string

None.

CommentOtherShift

string

None.

CommentEndedTooSoon

string

None.

CommentStartedTooSoon

string

None.

CommentEndedTooLate

string

None.

DistanceKm

distance between start and end of the registration

decimal number

None.

DistanceKMBetweenGpsAndQR

distance between the gps of the activity and the location of the user.

decimal number

None.

QRCodeScanWasSkippedByUser

store the fact that a user skipped the qr-code scan.

boolean

None.

QRCodeIsUnknown

Store the fact that the scanned QR code did not result in a valid activity.

boolean

None.

RegisteredOnline

Stores the fact if a registration started offline

boolean

None.

ActualStartTimeDetermined

Store the fact if a starttime was determined by a atomclock

boolean

None.

ActualEndTimeDetermined

Store the fact if a endtime was determined by a atomclock

boolean

None.

GpsCheck

Store what Gps checks did or did not succeed.

GpsChecked

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "DutyID": 2,
  "StartTime": "2024-12-21T15:06:30.314283+01:00",
  "EndTime": "2024-12-21T15:06:30.314283+01:00",
  "CommentStartedTooLate": "sample string 5",
  "CommentOtherShift": "sample string 6",
  "CommentEndedTooSoon": "sample string 7",
  "CommentStartedTooSoon": "sample string 8",
  "CommentEndedTooLate": "sample string 9",
  "DistanceKm": 10.1,
  "DistanceKMBetweenGpsAndQR": 11.1,
  "QRCodeScanWasSkippedByUser": true,
  "QRCodeIsUnknown": true,
  "RegisteredOnline": true,
  "ActualStartTimeDetermined": true,
  "ActualEndTimeDetermined": true,
  "GpsCheck": 0
}

application/xml, text/xml

Sample:
<TimeRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RostarCASWebAPI.Models">
  <ActualEndTimeDetermined>true</ActualEndTimeDetermined>
  <ActualStartTimeDetermined>true</ActualStartTimeDetermined>
  <CommentEndedTooLate>sample string 9</CommentEndedTooLate>
  <CommentEndedTooSoon>sample string 7</CommentEndedTooSoon>
  <CommentOtherShift>sample string 6</CommentOtherShift>
  <CommentStartedTooLate>sample string 5</CommentStartedTooLate>
  <CommentStartedTooSoon>sample string 8</CommentStartedTooSoon>
  <DistanceKMBetweenGpsAndQR>11.1</DistanceKMBetweenGpsAndQR>
  <DistanceKm>10.1</DistanceKm>
  <DutyID>2</DutyID>
  <EndTime>2024-12-21T15:06:30.314283+01:00</EndTime>
  <GpsCheck>UnKnown</GpsCheck>
  <ID>1</ID>
  <QRCodeIsUnknown>true</QRCodeIsUnknown>
  <QRCodeScanWasSkippedByUser>true</QRCodeScanWasSkippedByUser>
  <RegisteredOnline>true</RegisteredOnline>
  <StartTime>2024-12-21T15:06:30.314283+01:00</StartTime>
</TimeRegistrationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TimeRegistrationModel
NameDescriptionTypeAdditional information
ID

integer

None.

DutyID

integer

None.

StartTime

date

None.

EndTime

date

None.

CommentStartedTooLate

string

None.

CommentOtherShift

string

None.

CommentEndedTooSoon

string

None.

CommentStartedTooSoon

string

None.

CommentEndedTooLate

string

None.

DistanceKm

distance between start and end of the registration

decimal number

None.

DistanceKMBetweenGpsAndQR

distance between the gps of the activity and the location of the user.

decimal number

None.

QRCodeScanWasSkippedByUser

store the fact that a user skipped the qr-code scan.

boolean

None.

QRCodeIsUnknown

Store the fact that the scanned QR code did not result in a valid activity.

boolean

None.

RegisteredOnline

Stores the fact if a registration started offline

boolean

None.

ActualStartTimeDetermined

Store the fact if a starttime was determined by a atomclock

boolean

None.

ActualEndTimeDetermined

Store the fact if a endtime was determined by a atomclock

boolean

None.

GpsCheck

Store what Gps checks did or did not succeed.

GpsChecked

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "DutyID": 2,
  "StartTime": "2024-12-21T15:06:30.3299026+01:00",
  "EndTime": "2024-12-21T15:06:30.3299026+01:00",
  "CommentStartedTooLate": "sample string 5",
  "CommentOtherShift": "sample string 6",
  "CommentEndedTooSoon": "sample string 7",
  "CommentStartedTooSoon": "sample string 8",
  "CommentEndedTooLate": "sample string 9",
  "DistanceKm": 10.1,
  "DistanceKMBetweenGpsAndQR": 11.1,
  "QRCodeScanWasSkippedByUser": true,
  "QRCodeIsUnknown": true,
  "RegisteredOnline": true,
  "ActualStartTimeDetermined": true,
  "ActualEndTimeDetermined": true,
  "GpsCheck": 0
}

application/xml, text/xml

Sample:
<TimeRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RostarCASWebAPI.Models">
  <ActualEndTimeDetermined>true</ActualEndTimeDetermined>
  <ActualStartTimeDetermined>true</ActualStartTimeDetermined>
  <CommentEndedTooLate>sample string 9</CommentEndedTooLate>
  <CommentEndedTooSoon>sample string 7</CommentEndedTooSoon>
  <CommentOtherShift>sample string 6</CommentOtherShift>
  <CommentStartedTooLate>sample string 5</CommentStartedTooLate>
  <CommentStartedTooSoon>sample string 8</CommentStartedTooSoon>
  <DistanceKMBetweenGpsAndQR>11.1</DistanceKMBetweenGpsAndQR>
  <DistanceKm>10.1</DistanceKm>
  <DutyID>2</DutyID>
  <EndTime>2024-12-21T15:06:30.3299026+01:00</EndTime>
  <GpsCheck>UnKnown</GpsCheck>
  <ID>1</ID>
  <QRCodeIsUnknown>true</QRCodeIsUnknown>
  <QRCodeScanWasSkippedByUser>true</QRCodeScanWasSkippedByUser>
  <RegisteredOnline>true</RegisteredOnline>
  <StartTime>2024-12-21T15:06:30.3299026+01:00</StartTime>
</TimeRegistrationModel>