The Food Services Working Group specifies, implements, and promotes a standard set of messages and automated communication mechanisms that allow computer applications for the food service sector of the education industry to effectively exchange information with all SIF applications.
This object communicates information about food service items.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceItem | |||||
@ | RefId | M | GUID that identifies this item | RefIdType | |
LocalId | M | Item number as presented to user. | LocalIdType | ||
Description | O | Description of Item | xs:normalizedString | ||
ElectronicIdList | O | Electronic identifier(s) associated with this item. | ElectronicIdListType | ||
ItemCategory | O | The category is derived from the Child Nutrition Database's food category codes/names (Source: Food Category Name File [CNDB]). Agents may use the actual codes or a district's local definition of the names associated with the codes. The Child Nutrition Database [CNDB] is updated on a yearly basis by the USDA. Examples | xs:normalizedString | ||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object describes a certain amount for a specific item unit.
Note that this version of the object does not contain any elements that define item pricing. This task is left for future development.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceItemPortion | This object describes a certain amount for a specific item unit. Note that this version of the object does not contain any elements that define item pricing. This task is left for future development. | ||||
@ | RefId | M | GUID that identifies this item's portion | RefIdType | |
FoodserviceItemUnitRefId | M | GUID that identifies related item portion | IdRefType | ||
ItemPortionQuantity | M | Quantity of item portion (number of units) | xs:decimal | ||
ItemPortionType | M | Type of item unit | xs:token | ||
@ | Codeset | O | A unique indicator (usually a URL) that points to the codeset used. | xs:token | |
Description | O | Optional description of amount | xs:normalizedString | ||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object gives the sales details for the items sold for a specified date.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceItemSales | This object gives the sales details for the items sold for a specified date. | ||||
@ | RefId | M | GUID that identifies this object | RefIdType | |
SchoolInfoRefId | M | GUID that identifies the school for this object | IdRefType | ||
Date | M | Date of sales | xs:date | ||
Program | M | FundedProgramType | |||
ItemQuantities | M | FoodserviceItemQuantityListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object describes the unit for an item.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceItemUnit | This object describes the unit for an item. | ||||
@ | RefId | M | GUID that identifies this unit | RefIdType | |
FoodserviceItemRefId | M | GUID that identifies related item | IdRefType | ||
Description | M | Description of unit ("cup", "teaspoon", etc.) | xs:string | ||
MeasureDescriptionCode | M | Child Nutrition Database [CNDB] standard code describing unit. The database is updated on a yearly basis by the USDA. | xs:normalizedString | ||
GramWeight | M | Gram weight of this item in terms of MeasureDescriptionCode | xs:decimal | ||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object is a site's meal prices for each grade program, meal status, meal type and grade level.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceMealPrices | This object is a site's meal prices for each grade program, meal status, meal type and grade level. | ||||
@ | RefId | M | GUID that identifies this meal price. | RefIdType | |
SchoolInfoRefId | M | GUID that identifies the school this meal price belongs to | IdRefType | ||
Program | M | FundedProgramType | |||
Prices | M | MealPriceListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the foodservice menu plan for a school site for a given meal program, grade level range and date.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceMenuPlan | This object communicates the foodservice menu plan for a school site for a given meal program, grade level range and date. | ||||
@ | RefId | M | GUID that identifies this menu plan | RefIdType | |
SchoolInfoRefId | M | GUID that identifies the school for this menu plan | IdRefType | ||
GradeLevels | M | GradeLevelsType | |||
MenuPlanDate | M | Date of menu plan | xs:date | ||
Program | M | FundedProgramType | |||
Description | O | Description of menu plan | xs:string | ||
ProjectedParticipation | M | Feeding figure projected | xs:string | ||
MenuPlanQuantities | M | MenuPlanQuantityListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the daily milk sales at a school.
SIF_Events are not reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceMilkSales | This object communicates the daily milk sales at a school. | ||||
@ | RefId | M | GUID that identifies the daily milk sales object | RefIdType | |
SchoolInfoRefId | M | School for which the sales object applies | IdRefType | ||
Date | M | Date on which the sales occurred. | xs:date | ||
Program | M | FundedProgramType | |||
SaleQuantities | M | MilkSaleQuantityListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
If a food service transaction is of type Purchase
then this object can give the details of the purchase.
This object does not exist for other transaction types.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodservicePurchaseTransaction |
If a food service transaction is of type | ||||
@ | RefId | M | GUID that identifies purchase transaction | RefIdType | |
FoodserviceTransactionRefId | M | GUID that identifies food service transaction in which this purchase was made | IdRefType | ||
PurchaseQuantities | M | FoodservicePurchaseQuantityListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object describes the federal, state, local and other reimbursement rates for a school.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceReimbursementRates | This object describes the federal, state, local and other reimbursement rates for a school. | ||||
@ | RefId | M | GUID that identifies this object. | RefIdType | |
SchoolInfoRefId | M | GUID that identifies the school. | IdRefType | ||
StartDate | M | Effective start date for the reimbursement rates | xs:date | ||
EndDate | M | Effective end date for the reimbursement rates | xs:date | ||
Program | M | FundedProgramType | |||
Agencies | M | List of reimbursing agencies. | FoodserviceReimbursementAgencyListType | ||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the daily sales information.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceSales | This object communicates the daily sales information. | ||||
@ | RefId | M | GUID that identifies the daily meal sales object | RefIdType | |
SchoolInfoRefId | M | School for which the sales object applies | IdRefType | ||
Date | M | Date on which the sales occurred. | xs:date | ||
Program | M | FundedProgramType | |||
SalesAmounts | M | FoodserviceSalesAmountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the staff enrollment for a specified date.
SIF_Events are not reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceStaffEnrollmentCount | This object communicates the staff enrollment for a specified date. | ||||
@ | RefId | M | A GUID that identifies an instance of this object. This RefId is a “transient” value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MUST NOT be used in a later Request for the object. | RefIdType | |
@ | SchoolInfoRefId | M | Reference to SchoolInfo | IdRefType | |
@ | Date | M | Date the count is taken. | xs:date | |
Program | M | FundedProgramType | |||
Counts | M | FSCountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the daily staff sales.
SIF_Events are not reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceStaffMealCounts | This object communicates the daily staff sales. | ||||
@ | RefId | M | GUID that identifies the daily meal sales object | RefIdType | |
SchoolInfoRefId | M | School for which the sales object applies | IdRefType | ||
Date | M | Date on which the sales occurred. | xs:date | ||
Program | M | xs:token | |||
@ | Type | M | The type of the program. Type identifies the list of values. | xs:string | |
@ | Codeset | O | A unique indicator (usually a URL) that points to the codeset used. | xs:token | |
Counts | M | FSCountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the student enrollment for a specified date.
SIF_Events are not reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceStudentEnrollmentCount | This object communicates the student enrollment for a specified date. | ||||
@ | RefId | M | A GUID that identifies an instance of this object. This RefId is a “transient” value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MUST NOT be used in a later Request for the object. | RefIdType | |
@ | SchoolInfoRefId | M | Reference to SchoolInfo | IdRefType | |
@ | Date | M | Date the count is taken. | xs:date | |
Program | M | FundedProgramType | |||
Counts | M | FSCountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the daily student sales.
SIF_Events are not reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceStudentMealCounts | This object communicates the daily student sales. | ||||
@ | RefId | M | GUID that identifies the daily meal sales object | RefIdType | |
SchoolInfoRefId | M | School for which the sales object applies | IdRefType | ||
Date | M | Date on which the sales occurred. | xs:date | ||
Program | M | FundedProgramType | |||
Counts | M | FSCountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates food service transaction information. This is the key object that will be present for every food service transaction.
Note: With SIF Implementation Specification version 2.4 the choice element depicted in the diagram below has changed. In the XSD files, the choice element used to be rendered as a sequence of optional elements. Now, in the XSD files, the choice element is rendered as an xs:choice. This may cause problems with agents that treat the choice element as two optional elements rather than a choice of one and only one of the choices.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceTransaction | This object communicates food service transaction information. This is the key object that will be present for every food service transaction. Note: With SIF Implementation Specification version 2.4 the choice element depicted in the diagram below has changed. In the XSD files, the choice element used to be rendered as a sequence of optional elements. Now, in the XSD files, the choice element is rendered as an xs:choice. This may cause problems with agents that treat the choice element as two optional elements rather than a choice of one and only one of the choices. | ||||
@ | RefId | M | GUID that identifies food service transaction | RefIdType | |
SchoolInfoRefId | M | GUID that identifies the school/site of account transaction | IdRefType | ||
Program | M | FundedProgramType | |||
TransactionDate | M | Date of transaction | xs:date | ||
TransactionTime | M | Time of transaction. | xs:time | ||
TransactionTypes | M | FoodserviceTransactionListType | |||
Customer | M | The customer can be a student or staff. | FoodserviceCustomerType | ||
Amount | M | FSAmountType | |||
Tax | O | Amount of tax. Note: Final amount is Amount/Value + Tax | MonetaryAmountType | ||
Description | O | Description of the Transaction | xs:string | ||
Voided | M | This flag tells us if the transaction is voided. | xs:token | ||
@ | Codeset | O | A unique indicator (usually a URL) that points to the codeset used. | xs:token | |
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object gives the transaction distribution for food service transactions of type other than Purchase
. So, this
object can be requested for transactions of type Prepayment
, Repayment
, Refund
, Adjustment
.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceTransactionDetails |
This object gives the transaction distribution for food service transactions of type other than | ||||
@ | RefId | M | GUID that identifies transaction details | RefIdType | |
FoodserviceTransactionRefId | M | GUID that identifies food service transaction | IdRefType | ||
Amounts | M | FSAmountListType | |||
Description | O | Description | xs:string | ||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the funding for a given transaction. By the term funding we refer to the form of payment that is made for the transaction.
SIF_Events are reported for this object.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
FoodserviceTransactionPayMethod | This object communicates the funding for a given transaction. By the term funding we refer to the form of payment that is made for the transaction. | ||||
@ | RefId | M | GUID that identifies the payment | RefIdType | |
FoodserviceTransactionRefId | M | GUID that identifies food service transaction | IdRefType | ||
TransactionPayMethods | M | FoodservicePayMethodListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the current meal status and account status of a given staff member. This object indicates whether the staff member is entitled to earn meals.
SIF_Events, typically Change events, can be reported.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
StaffMeal | This object communicates the current meal status and account status of a given staff member. This object indicates whether the staff member is entitled to earn meals. | ||||
@ | RefId | M | A GUID that identifies an instance of this object. This RefId is new for 2.7M and MUST be supported like other objects that have a RefId (i.e. it is the key for the object). The alternate keys MUST continue to be supported. | RefIdType | |
@ | StaffPersonalRefId | M | The GUID of the staff to whom this object is linked. | IdRefType | |
EarnedStatus | M | EarnedStatusType | |||
LastBreakfastDate | M | Last breakfast served date | xs:date | ||
LastLunchDate | M | Last lunch served date | xs:date | ||
Amounts | M | FSAmountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates the current meal/account status of a given student.
This object will return information such as the amount of remaining breakfast/lunch credits, cash balance, meal status (free/reduced), etc. Systems may optionally support the historical reporting of a student's meal status (free/reduced).
SIF_Events, typically Change events, can be reported.
Element/@Attribute | Char | CEDS Id/URL | Description | Type | |
---|---|---|---|---|---|
StudentMeal | This object communicates the current meal/account status of a given student. This object will return information such as the amount of remaining breakfast/lunch credits, cash balance, meal status (free/reduced), etc. Systems may optionally support the historical reporting of a student's meal status (free/reduced). | ||||
@ | RefId | M | A GUID that identifies an instance of this object. This RefId is new for 2.7M and MUST be supported like other objects that have a RefId (i.e. it is the key for the object). The alternate keys MUST continue to be supported. | RefIdType | |
@ | StudentPersonalRefId | M | The GUID of the student to whom this object is linked. | IdRefType | |
MealStatus | O | The student's current meal status. | MealStatusType | ||
HistoricalMealStatus | O |
Optionally provides the meal status of the student historically. Note that as this status is historical, | MealStatusListType | ||
LastBreakfastDate | O | Date of the last reimbursable breakfast served. | xs:date | ||
LastLunchDate | O | Date of the last reimbursable lunch served. | xs:date | ||
Amounts | O | FSAmountListType | |||
SIF_Metadata | O | SIF_MetadataType | |||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |