SIF Implementation Specification Unity - Transportation and Geographic Information Working Group

3.18.1 BusEquipment

This object contains information about a type of equipment that may be on a bus. Examples include wheelchair, car seat, etc.

SIF_Events are reported for this object.

Figure 3.18.1-1: BusEquipment

	Element/@Attribute	Char	Description	Type
	BusEquipment		This object contains information about a type of equipment that may be on a bus. Examples include wheelchair, car seat, etc.
@	RefId	M	GUID that identifies this type of equipment.	RefIdType
	Description	M	Explanation about the type of equipment.	xs:string
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.1-1: BusEquipment

JSON

{ "BusEquipment": { "RefId": "D3E34B359D75101A8C3D00AA001A1652", "Description": "Wheelchair" } }

XML

<BusEquipment RefId="D3E34B359D75101A8C3D00AA001A1652"> <Description>Wheelchair</Description> </BusEquipment>

Example 3.18.1-1: BusEquipment

3.18.2 BusInfo

This object contains all of the information about a bus.

SIF_Events are reported for this object.

Figure 3.18.2-1: BusInfo

	Element/@Attribute	Char	Description	Type
	BusInfo		This object contains all of the information about a bus.
@	RefId	M	GUID that identifies this bus.	RefIdType
	VehicleNumber	M	Vehicle number of the bus.	xs:normalizedString
	SeatingCapacity	O	The number of people who can ride on the bus at the same time.	xs:unsignedInt
	Contractor	O	The name of the contractor for this bus.	xs:normalizedString
	EquipmentList	O	Describes any special equipment that is on this bus.	BusInfoEquipmentListType
	ManufactureYear	O	The manufacture year of the bus (CCYY).	xs:gYear
	VehicleIdentificationNumber	O	The Vehicle Identification Number (VIN) of the bus.	xs:normalizedString
	LicensePlateNumber	O	The vehicle's license plate number.	xs:normalizedString
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.2-1: BusInfo

JSON

{ "BusInfo": { "RefId": "D3E34B359D75101A8C3D00AA001A1652", "VehicleNumber": "63", "SeatingCapacity": 71, "Contractor": "RYDER", "EquipmentList": { "Equipment": [ { "BusEquipmentRefId": "E2F23A5323E87343B9A34BE457321E4A", "Count": 3 }, { "BusEquipmentRefId": "34BE45E87343B9A5323A73212F23E7B3", "Count": 4 } ] }, "ManufactureYear": "2001", "VehicleIdentificationNumber": "12333992AB", "LicensePlateNumber": "BLA254" } }

XML

<BusInfo RefId="D3E34B359D75101A8C3D00AA001A1652"> <VehicleNumber>63</VehicleNumber> <SeatingCapacity>71</SeatingCapacity> <Contractor>RYDER</Contractor> <EquipmentList> <Equipment> <BusEquipmentRefId>E2F23A5323E87343B9A34BE457321E4A</BusEquipmentRefId> <Count>3</Count> </Equipment> <Equipment> <BusEquipmentRefId>34BE45E87343B9A5323A73212F23E7B3</BusEquipmentRefId> <Count>4</Count> </Equipment> </EquipmentList> <ManufactureYear>2001</ManufactureYear> <VehicleIdentificationNumber>12333992AB</VehicleIdentificationNumber> <LicensePlateNumber>BLA254</LicensePlateNumber> </BusInfo>

Example 3.18.2-1: BusInfo

3.18.3 BusPositionInfo

This object exposes telematics information to the zone.

SIF_Events are reported for this object.

Figure 3.18.3-1: BusPositionInfo

	Element/@Attribute	Char	Description	Type
	BusPositionInfo		This object exposes telematics information to the zone.
@	RefId	M	The GUID that identifies the bus. This object only has meaning as current data for this particular bus.	IdRefType
	Date	M	The date of the report from the bus.	xs:date
	Time	M	The time of the report from the bus.	xs:time
	GridLocation	M	The location of the bus.	GridLocationType
	TelematicsId	O	Id of the hardware unit on the bus that tracks and reports location and status. The interpretation of the content is deployment specific, but the format must be compact.	xs:normalizedString
	TelemetryList	O		TelemetryListType
	BusDriver	O	Information identifying the driver.	BusStaffType
	BusStaffList	O	List identifying other staff. This may include aides, nurses, proctors, etc.	BusStaffListType
	RouteStatus	C	If the bus is running a route, this element must be included in the object. Absence means the bus is not operating a route.	BusRouteStatusType
	OtherStatus	C	If the bus is not running a regularly scheduled route but is transporting (or positioning to transport) passengers as approved and directed by the school district, this element describes the activity. It's also used for maintenance, repair, and other authorized movements. This element is mutually exclusive with RouteStatus. Absence of both RouteStatus and OtherStatus is acceptable, but may indicate unauthorized operation. The following values are suggested to enhance interoperability, but the field is free-form. Suggested Values: Field Trip Sporting Event Support Services Maintenance Repair	xs:normalizedString
	Odometer	O	Current odometer reading.	DistanceType
	Speedometer	O	Current speedometer reading.	DistanceType
	Students	O	A list of students and their statuses. The complete list may be sent with some events (e.g. change in RouteStatus) per district policy, but it is more typical of responses.	BusPositionStudentListType
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.3-1: BusPositionInfo

JSON

{ "BusPositionInfo": { "RefId": "A2E35B359D75101A8C3D00AA001A0000", "Date": "2003-10-13", "Time": "13:39:12-08:00", "GridLocation": { "Latitude": 41.85, "Longitude": -87.65 }, "TelematicsId": "NexTel866-456-7890", "TelemetryList": { "Telemetry": [ "Close" ] }, "BusDriver": { "EmployeePersonalRefId": "BB0300099D75101A8C3D00AA001A0000", "Status": { "value": "Sched" } }, "RouteStatus": { "BusRouteInfoRefId": "D3E34B359D75101A8C3D00AA001A1652", "Status": "Continue" }, "Odometer": { "Unit": "km", "value": 100000.0 }, "Speedometer": { "Unit": "km", "value": 60 }, "Students": { "Student": [ { "StudentPersonalRefId": "F3B35B359D75101A8C3D00AA001A0000", "Status": { "value": "Entered" } }, { "StudentPersonalRefId": "A7E35B359D75101A8C3D00BB211A0000", "Status": { "value": "Entered" } }, { "StudentPersonalRefId": "A9D35B359D75101A8C3D00AA001A9999", "Status": { "value": "Entered" } } ] } } }

XML

<BusPositionInfo RefId="A2E35B359D75101A8C3D00AA001A0000"> <Date>2003-10-13</Date> <Time>13:39:12-08:00</Time> <GridLocation> <Latitude>41.850000</Latitude> <Longitude>-87.650000</Longitude> </GridLocation> <TelematicsId>NexTel866-456-7890</TelematicsId> <TelemetryList> <Telemetry>Close</Telemetry> </TelemetryList> <BusDriver> <EmployeePersonalRefId>BB0300099D75101A8C3D00AA001A0000</EmployeePersonalRefId> <Status>Sched</Status> </BusDriver> <RouteStatus> <BusRouteInfoRefId>D3E34B359D75101A8C3D00AA001A1652</BusRouteInfoRefId> <Status>Continue</Status> </RouteStatus> <Odometer Unit="km">100000.0</Odometer> <Speedometer Unit="km">60</Speedometer> <Students> <Student> <StudentPersonalRefId>F3B35B359D75101A8C3D00AA001A0000</StudentPersonalRefId> <Status>Entered</Status> </Student> <Student> <StudentPersonalRefId>A7E35B359D75101A8C3D00BB211A0000</StudentPersonalRefId> <Status>Entered</Status> </Student> <Student> <StudentPersonalRefId>A9D35B359D75101A8C3D00AA001A9999</StudentPersonalRefId> <Status>Entered</Status> </Student> </Students> </BusPositionInfo>

Example 3.18.3-1: BusPositionInfo

3.18.4 BusRouteDetail

This object contains the schedule for the bus route.

SIF_Events are reported for this object.

Figure 3.18.4-1: BusRouteDetail

	Element/@Attribute	Char	Description	Type
	BusRouteDetail		This object contains the schedule for the bus route.
@	RefId	M	GUID that identifies this object.	RefIdType
@	BusRouteInfoRefId	M	GUID that identifies the bus route.	IdRefType
	BusStopInfoRefId	M	GUID that identifies a bus stop on the route.	IdRefType
	ArrivalTime	M	The time that the bus associated with this route will stop at this bus stop.	xs:time
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.4-1: BusRouteDetail

JSON

{ "BusRouteDetail": { "RefId": "D3E34B359D75101A8C3D00AA001A1652", "BusRouteInfoRefId": "C2F23F450B86234B9B3D00AA001A1652", "BusStopInfoRefId": "B7A34E561C97345C0A4E11BB112B2753", "ArrivalTime": "15:39:00-08:00" } }

XML

Example 3.18.4-1: BusRouteDetail

3.18.5 BusRouteInfo

This object contains all of the information about a bus route.

SIF_Events are reported for this object.

Figure 3.18.5-1: BusRouteInfo

	Element/@Attribute	Char	Description	Type
	BusRouteInfo		This object contains all of the information about a bus route.
@	RefId	M	GUID that identifies this bus route.	RefIdType
	BusInfoRefId	M	GUID that identifies the bus that is associated with this route.	IdRefType
	RouteNumber	M	A unique identifier for the route. It may contain any printable ASCII character. F or instance, you may have route 16AM in the morning and a 16PM in the afternoon.	xs:normalizedString
	RouteType	M	The type of route.	xs:token
@	Codeset	O	A unique indicator (usually a URL) that points to the codeset used.	xs:token
	MaximumLoad	O	The maximum number of students who are on the bus at any point along this route.	xs:unsignedInt
	Description	O	Short explanation of the route. It may be used to designate an area, or used to color-code bus routes (the "orange" route).	xs:string
	Name	O	Name of the driver who drives this route.	NameType
	RouteDurationLoaded	O	Refers to the amount of time that at least one student is riding the bus.	xs:duration
	RouteDurationTotal	O	Includes time when no student is on the bus, including time driving to and from the garage, etc.	xs:duration
	RouteDistanceLoaded	O	Refers to the distance the bus drives when at least one student is riding the bus.	DistanceType
	RouteDistanceTotal	O	Includes the total distance driven for this route including to and from garage.	DistanceType
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.5-1: BusRouteInfo

JSON

{ "BusRouteInfo": { "RefId": "D3E34B359D75101A8C3D00AA001A1652", "BusInfoRefId": "A2E35B359D75101A8C3D00AA001A0000", "RouteNumber": "16AM", "RouteType": { "value": "Inbound" }, "MaximumLoad": 40, "Description": "1st Transfer Bus", "Name": { "Type": "02", "LastName": "Smith", "FirstName": "Jon" }, "RouteDurationLoaded": "PT16M45S", "RouteDurationTotal": "PT28M00S", "RouteDistanceLoaded": { "Unit": "m", "value": 5.23 }, "RouteDistanceTotal": { "Unit": "m", "value": 9.9 } } }

XML

<BusRouteInfo RefId="D3E34B359D75101A8C3D00AA001A1652"> <BusInfoRefId>A2E35B359D75101A8C3D00AA001A0000</BusInfoRefId> <RouteNumber>16AM</RouteNumber> <RouteType>Inbound</RouteType> <MaximumLoad>40</MaximumLoad> <Description>1st Transfer Bus</Description> <Name Type="02"> <LastName>Smith</LastName> <FirstName>Jon</FirstName> </Name> <RouteDurationLoaded>PT16M45S</RouteDurationLoaded> <RouteDurationTotal>PT28M00S</RouteDurationTotal> <RouteDistanceLoaded Unit="m">5.23</RouteDistanceLoaded> <RouteDistanceTotal Unit="m">9.9</RouteDistanceTotal> </BusRouteInfo>

Example 3.18.5-1: BusRouteInfo

3.18.6 BusStopInfo

This object contains information about a bus stop.

SIF_Events are reported for this object.

Figure 3.18.6-1: BusStopInfo

	Element/@Attribute	Char	Description	Type
	BusStopInfo		This object contains information about a bus stop.
@	RefId	M	GUID that identifies this location.	RefIdType
	Description	M	An explanation of this location.	xs:string
	GridLocation	O	The location of the bus stop.	GridLocationType
	SIF_Metadata	O		SIF_MetadataType
	SIF_ExtendedElements	O		SIF_ExtendedElementsType

Table 3.18.6-1: BusStopInfo

JSON

{ "BusStopInfo": { "RefId": "D3E34B359D75101A8C3D00AA001A1652", "Description": "Elm St @ Pine Ave", "GridLocation": { "Latitude": 41.85, "Longitude": -87.65 } } }

XML

Example 3.18.6-1: BusStopInfo

3.18.7 StudentTransportInfo

This object contains transportation information about a student. Students should have at least two StudentTransportInfo objects associated with them: one for inbound information (getting to school) and one for outbound information (leaving school). If their transportation changes based on the day of the week, then a student will have more than two StudentTransportInfo objects.

SIF_Events are reported for this object.

Figure 3.18.7-1: StudentTransportInfo

Element/@Attribute Char CEDS Id/URL Description Type

StudentTransportInfo

This object contains transportation information about a student. Students should have at least two StudentTransportInfo objects associated with them: one for inbound information (getting to school) and one for outbound information (leaving school). If their transportation changes based on the day of the week, then a student will have more than two StudentTransportInfo objects.

@