DataService
The following operations are supported. For a formal definition, please review the Service Description.
-
Echo
Returns the passed string - used to test the connection. -
FetchCurrentHotList
Returns a pass which has been recently hotlisted. The processedID parameter is used to indicate a pass that has been processed, that pass will be marked as processed and the next pass returned (0 can be used on the first call). If no pass details are returned (e.g. an ID of 0) then all hotlisted passes have been retrieved. -
FetchPupilDetails
Returns the pupil details associated with a specific pupil reference. -
FetchPupilList
Returns a list of pupil references attending a specific school on or after the effective from date. -
FetchSchoolDetails
Returns the school details associated with a specific school reference. -
FetchSchoolList
Returns a list of school references. -
FetchStopList
Returns a list of stop id numbers that are termination points for pupils attending a specified school on or after the effective from date. -
FetchTermDate
Returns a specific term period for a specific school starting on or after the effective from date. -
FetchTermDatesCount
Returns the number of term periods for a specific school starting on or after the effective from date. -
FetchUpdatedCalendar
Returns the Calendar Type and Year records for the first school calendar which has been modified since specified date/time. The year records will include term dates and will be retrieved in one request. This method also returns a Date/Time to pass into the next call to this method. If no Calendar is returned then all updates have been retrieved. -
FetchUpdatedOperator
Returns the first Operator record that has been modified since the specified date/time. This method also returns a Date/Time to pass into the next call to this method. If no Operator is returned then all updates have been retrieved. -
FetchUpdatedPass
Returns the first Pass record that has been modified since the specified date/time. This includes the journey legs associated with each pass. This method also returns a Date/Time to pass into the next call to this method. If no Pass is returned then all updates have been retrieved. -
FetchUpdatedSchool
Returns the first School record modified since the specified date/time. This method also returns a Date/Time to pass into the next call to this method. If no School is returned then all updates have been retrieved. -
FetchUpdatedStudent
Returns the first Student record modified since the specified date/time. This method also returns a Date/Time to pass into the next call to this method. Photos will be contained in the data as BASE64 encoded data (there is no plan to use DIME or MTOM). If no Student is returned then all updates have been retrieved. -
SetITSODetails
Uploads ITSO card data associated with a specific MVA Pass ID. Called for each pass assigned. Returns true if the record was processed successfully.