Back to API Page
| Universal API Rules |
|---|
The following rules apply to all of the fields used in the markup for all of the APIs
- Indentation is recommended to make debugging easier on you, but it is not enforced by the parser.
- All fields indicated as OPTIONAL (shown in the HTML versions) can be left with either nothing between them (eg: <BOB></BOB>),
only whitespace between them, or the tags can be left out completely. All of the preceding will have the same effect.
- A 'structure' will refer to a set of tags that are wrapped inside of a parent tag. Structures are therefore filled with tags while
other tags are filled with actual data.
- The order of the structures and of the tags inside each structure is not relevant to the parser, but it is recommended that you stick
as closely as possible to the order in the example files to make debugging easier.
- Even if uniqueNums are available at your school, they should be used IN ADDITION to the field, course, and section numbers, not instead.
As an additional note, it is hard to overemphasize how important the uniqueNums are. If your school does have unique numbers for each
section of each course (and your students would recognize these from their schedules or blue-books), please make an extra effort to make sure
you include these values even if they are just a conglomeration of the field, course and section numbers. If your students would not recognize
that each course does in fact have a unique number associated with it, please make sure to omit it in all cases so that our site knows to
display different options that will allow them to navigate by the field, course, and section numbers instead.
|
|