Back to API Page

[EXPAND ALL]   [COLLAPSE ALL]

	<AUTH_USERNAME></AUTH_USERNAME>
	This username will be provided to identify you as someone who is trusted to update the system at your school. Please note that not just any CollegeInfoDesk username will do: this needs to be specially assigned. If you do not have an authorized username / password combination, please contact us to set one up. Example: <AUTH_USERNAME>techTeam@fakeschool.edu</AUTH_USERNAME>

	<AUTH_PASSWORD></AUTH_PASSWORD>
	This password will be provided to identify you as someone who is trusted to update the system at your school. Please note that not just any CollegeInfoDesk username will do: this needs to be specially assigned. If you do not have an authorized username / password combination, please contact us to set one up.

	<SCHOOLCODE></SCHOOLCODE>
	The school code is the part of your school's URL just before the .edu Generally this will be displayed to you in all lowercase, but this field is not case-sensitive. Example: <SCHOOLCODE>rit</SCHOOLCODE>

<TERM>

	<TERMID></TERMID>
	This is the alphanumeric code that represents the term at your school. If your school does not have a specific format to represent terms, just make one up. It would be best (for ordering in drop-down boxes) if the alphabetical value of earlier terms was lower. Example: <TERMID>20053</TERMID> represents spring quarter of 2005-2006 at RIT

	<TERMNAME></TERMNAME>
	This is the human-readable form of the name for the term. Example: <TERMNAME>Spring 2005-2006</TERMNAME>

</TERM>

<FIELD>

	<TERMID></TERMID>
	This is the alphanumeric code that represents the term at your school. If your school does not have a specific format to represent terms, just make one up. It would be best (for ordering in drop-down boxes) if the alphabetical value of earlier terms was lower. Example: <TERMID>20053</TERMID> represents spring quarter of 2005-2006 at RIT

	<FIELDNUM></FIELDNUM>
	This is the number (or alphanumeric in many cases) that represents the field of study. At many schools this is just a number or an abbreviated version of the full name of the field. Single and double quotes are not permitted to be in this value. Example: <FIELDNUM>0101</FIELDNUM> (numbers at RIT) Example: <FIELDNUM>ECON</FIELDNUM> (strings at PSU)

	<FIELDNAME></FIELDNAME>
	The full name of the field. Single and double quotes are not permitted. Example: <FIELDNAME>Computer Science</FIELDNAME>

	<FIELDICON></FIELDICON>
	OPTIONAL This field is the name of the icon found on the field icons page. It is not case-sensitive. If no value is specified for this field, the default icon will be used. NOTE: If this whole structure is being filled in by an automated script, it may be easier to manually match the icon using the ICON structure below. Example: <FIELDICON>ENGINEERING</FIELDICON>

</FIELD>

<COURSE>

	<TERMID></TERMID>
	This is the alphanumeric code that represents the term at your school. If your school does not have a specific format to represent terms, just make one up. It would be best (for ordering in drop-down boxes) if the alphabetical value of earlier terms was lower. Example: <TERMID>20053</TERMID> represents spring quarter of 2005-2006 at RIT

	<FIELDNUM></FIELDNUM>
	This is the number (or alphanumeric in many cases) that represents the field of study. At many schools this is just a number or an abbreviated version of the full name of the field. Single and double quotes are not permitted to be in this value. Example: <FIELDNUM>0101</FIELDNUM> (numbers at RIT) Example: <FIELDNUM>ECON</FIELDNUM> (strings at PSU)

	<COURSENUM></COURSENUM>
	This is the number of the course inside of the discipline. Put differently: this would be the '101' in Programming 101. Example: <COURSENUM>250</COURSENUM>

	<COURSENAME></COURSENAME>
	This is the full name of the course. For example, in addition to being called CS 380, the course may actually have the name "Intro to CS Theory". Single and double quotes are not permitted in the value. If there is no such common name, please put the field/course equivalent (such as "CS 380") here. Example: <COURSENAME>Intro to CS Theory</COURSENAME>

	<COURSEINFO></COURSEINFO>
	OPTIONAL This space can be used to put a full description of the course. HTML will not be shown (for security reasons), so a hyperlink passed in here wouldn't be an actual link but would instead display the <a href=... > etc. If your line-breaks are represented as <BR>, those will still work because they will be converted when they are received. If your line-breaks are already \n's, and outputting them would result in this text being on multiple lines, that is also acceptable. Only leading and trailing whitespace will be deleted. If you need to make links to another course (for prerequisites, etc.) use this format: [course link=fieldNum,courseNum,sectionNum]CS 250[/course] leaving the sectionNum blank if you mean a whole course regardless of section. If you mean a specific section and you have a uniqueNum available, you can also use this: [course uniqueNum=uniqueNum]Comp Sci[/course] To get a better idea of this, see the example. The maximum length for this value is 65,535 characters. Example: <COURSEINFO>Introduction to the classical and contemporary theory of computation covering regular, context-free and computable (recursive) languages with finite state machines, pushdown automata and turing machines. Basic concepts of computability theory and NP-theory. (Prereq: [course link=1016,265,]1016-265[/course]; [course link=1016,366,]1016-366[/course] as a corequisite)</COURSEINFO>

</COURSE>

<SECTION>

	<TERMID></TERMID>
	This is the alphanumeric code that represents the term at your school. If your school does not have a specific format to represent terms, just make one up. It would be best (for ordering in drop-down boxes) if the alphabetical value of earlier terms was lower. Example: <TERMID>20053</TERMID> represents spring quarter of 2005-2006 at RIT

	<FIELDNUM></FIELDNUM>
	This is the number (or alphanumeric in many cases) that represents the field of study. At many schools this is just a number or an abbreviated version of the full name of the field. Single and double quotes are not permitted to be in this value. Example: <FIELDNUM>0101</FIELDNUM> (numbers at RIT) Example: <FIELDNUM>ECON</FIELDNUM> (strings at PSU)

	<COURSENUM></COURSENUM>
	This is the number of the course inside of the discipline. Put differently: this would be the '101' in Programming 101. Example: <COURSENUM>250</COURSENUM>

	<SECTIONNUM></SECTIONNUM>
	The number representing the section of the course. Although this goes by a different name at some schools, the section is the individual class of a course that a student would sign up for. (See also: UNIQUENUM) Example: <SECTIONNUM>01</SECTIONNUM>

	<UNIQUENUM></UNIQUENUM>
	OPTIONAL If your school has unique numbers (or alphanumerics) for each section of each course, then they should be used here. This will allow students to find courses more easily using just this number to get exactly what they need. If your school does not have unique numbers for each course, just leave this tag empty or omit it entirely. Example: <UNIQUENUM>400325001</UNIQUENUM> (numeric at RIT) Example: <UNIQUENUM>BIO2010 02</UNIQUENUM> (alphanumeric at Elmira)

	<INSTRUCTOR></INSTRUCTOR>
	OPTIONAL This is the professor instructing this section of the course. If there is more than one instructor, you may use more than one instructor tag. Please do not put both names in the same tag! (as always, line-breaks between tags are optional) Example: <INSTRUCTOR>Jon Smith</INSTRUCTOR><INSTRUCTOR>Jane Smith</INSTRUCTOR>

	<CREDITS></CREDITS>
	OPTIONAL Generally this means credit-hours, but some schools (such as Harvard) use different systems. Regardless, if you have an acceptable value available, please pass it in as a decimal or integer. Maximum of 2 digits before the decimal point and 2 digits after it. Example: <CREDITS>4</CREDITS>

	<ISLAB></ISLAB>
	OPTIONAL This is a boolean value, it should be true if this section is a lab. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. Example: <ISLAB>1</ISLAB> Example: <ISLAB>true</ISLAB> Example: <ISLAB>false</ISLAB>

	<ISONLINE></ISONLINE>
	OPTIONAL This is a boolean value, it should be true if this section is an online course. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. Example: <ISONLINE>1</ISONLINE> Example: <ISONLINE>true</ISONLINE> Example: <ISONLINE>false</ISONLINE>

	<ISEVENING></ISEVENING>
	OPTIONAL This is a boolean value, it should be true if this section is an evening course. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. If you don't have this data available for courses at your school, just ignore this field entirely; it will not cause any negative side effects. Example: <ISEVENING>1</ISEVENING> Example: <ISEVENING>true</ISEVENING> Example: <ISEVENING>false</ISEVENING>

	<SECTIONINFO></SECTIONINFO>
	OPTIONAL This space can be used to put extra notes on the section. This should not be used for a description of the course, that belongs in COURSEINFO. HTML will not be shown (for security reasons), so a hyperlink passed in here wouldn't be an actual link but would instead display the <a href=... > etc. If your line-breaks are represented as <BR>, those will still work because they will be converted when they are received. If your line-breaks are already \n's, and outputting them would result in this text being on multiple lines, that is also acceptable. Only leading and trailing whitespace will be deleted. If you need to make links to another course use this format: [course link=fieldNum,courseNum,sectionNum]CS 250[/course] leaving the sectionNum blank if you mean a whole course regardless of section. If you mean a specific section and you have a uniqueNum available, you can also use this: [course uniqueNum=uniqueNum]Comp Sci[/course] To get a better idea of this, see the example. The maximum length for this value is 65,535 characters. Example: <SECTIONINFO>This section has an ASL Interpreter</SECTIONINFO>

<MEETING>

	<DAYS></DAYS>
	This is a string of days from the options of "MTWRFSU" (representing monday through sunday respectively), of when there will be a meeting at this particular time and place NOTE: If the section meets in different places or at different times, please use multiple MEETINGs to represent this. So if a course met on Monday and Wednesday at one location and Teusday and Thursday at another location, you would need two MEETINGs (not one or four). Example: <DAYS>MWF</DAYS>

	<TIMESTART></TIMESTART>
	The time that the course starts. This should be hours and minutes (HH:MM), no seconds. Military time is recommended, but if an "am", "pm", "a", or "p" are detected, those will be used to generate the military time. You can use whichever format is in your database or is easier for you to send. Example: <TIMESTART>14:00</TIMESTART>

	<TIMEEND></TIMEEND>
	The time that the course ends. This should be hours and minutes (HH:MM), no seconds. Military time is recommended, but if an "am", "pm", "a", or "p" are detected, those will be used to generate the military time. You can use whichever format is in your database or is easier for you to send. Example: <TIMEEND>14:50</TIMEEND>

	<BUILDING></BUILDING>
	OPTIONAL The building that this particular meeting will be in. If there is more than one building, then you should use more than one set of MEETING tags. At many schools a number will suffice (recommended if possible), but if your school does not have numbers, other strings will work as well. Single and double quotes are not permitted. Example: <BUILDING>George Eastman Building</BUILDING> Example: <BUILDING>70</BUILDING> NOTE: these are different examples. The same meeting can not have multiple buildings: use multiple meetings to represent different places.

	<ROOM></ROOM>
	OPTIONAL The room that this particular meeting will be in. If there is more than one room, then you should use more than one set of MEETING tags. Numbers, as well as other strings work fine. Single and double quotes are not permitted. Example: <ROOM>1337</ROOM> Example: <ROOM>Colombo Auditorium</ROOM> NOTE: these are different examples. The same meeting can not have multiple rooms: use multiple meetings to represent different places.

</MEETING>
</SECTION>

If your database is set up such that it would be easier for you to represent the values all under one structure, you can use this format instead. Mixing formats is not recommended, but would work.
<TERM>

	<TERMID></TERMID>
	This is the alphanumeric code that represents the term at your school. If your school does not have a specific format to represent terms, just make one up. It would be best (for ordering in drop-down boxes) if the alphabetical value of earlier terms was lower. Example: <TERMID>20053</TERMID> represents spring quarter of 2005-2006 at RIT

	<TERMNAME></TERMNAME>
	This is the human-readable form of the name for the term. Example: <TERMNAME>Spring 2005-2006</TERMNAME>

<FIELD>

	<FIELDNUM></FIELDNUM>
	This is the number (or alphanumeric in many cases) that represents the field of study. At many schools this is just a number or an abbreviated version of the full name of the field. Single and double quotes are not permitted to be in this value. Example: <FIELDNUM>0101</FIELDNUM> (numbers at RIT) Example: <FIELDNUM>ECON</FIELDNUM> (strings at PSU)

	<FIELDNAME></FIELDNAME>
	The full name of the field. Single and double quotes are not permitted. Example: <FIELDNAME>Computer Science</FIELDNAME>

	<FIELDICON></FIELDICON>
	OPTIONAL This field is the name of the icon found on the field icons page. It is not case-sensitive. If no value is specified for this field, the default icon will be used. NOTE: If this whole structure is being filled in by an automated script, it may be easier to manually match the icon using the ICON structure below. Example: <FIELDICON>ENGINEERING</FIELDICON>

<COURSE>

	<COURSENUM></COURSENUM>
	This is the number of the course inside of the discipline. Put differently: this would be the '101' in Programming 101. Example: <COURSENUM>250</COURSENUM>

	<COURSENAME></COURSENAME>
	This is the full name of the course. For example, in addition to being called CS 380, the course may actually have the name "Intro to CS Theory". Single and double quotes are not permitted in the value. If there is no such common name, please put the field/course equivalent (such as "CS 380") here. Example: <COURSENAME>Intro to CS Theory</COURSENAME>

	<COURSEINFO></COURSEINFO>
	OPTIONAL This space can be used to put a full description of the course. HTML will not be shown (for security reasons), so a hyperlink passed in here wouldn't be an actual link but would instead display the <a href=... > etc. If your line-breaks are represented as <BR>, those will still work because they will be converted when they are received. If your line-breaks are already \n's, and outputting them would result in this text being on multiple lines, that is also acceptable. Only leading and trailing whitespace will be deleted. If you need to make links to another course (for prerequisites, etc.) use this format: [course link=fieldNum,courseNum,sectionNum]CS 250[/course] leaving the sectionNum blank if you mean a whole course regardless of section. If you mean a specific section and you have a uniqueNum available, you can also use this: [course uniqueNum=uniqueNum]Comp Sci[/course] To get a better idea of this, see the example. The maximum length for this value is 65,535 characters. Example: <COURSEINFO>Introduction to the classical and contemporary theory of computation covering regular, context-free and computable (recursive) languages with finite state machines, pushdown automata and turing machines. Basic concepts of computability theory and NP-theory. (Prereq: [course link=1016,265,]1016-265[/course]; [course link=1016,366,]1016-366[/course] as a corequisite)</COURSEINFO>

<SECTION>

	<SECTIONNUM></SECTIONNUM>
	The number representing the section of the course. Although this goes by a different name at some schools, the section is the individual class of a course that a student would sign up for. (See also: UNIQUENUM) Example: <SECTIONNUM>01</SECTIONNUM>

	<UNIQUENUM></UNIQUENUM>
	OPTIONAL If your school has unique numbers (or alphanumerics) for each section of each course, then they should be used here. This will allow students to find courses more easily using just this number to get exactly what they need. If your school does not have unique numbers for each course, just leave this tag empty or omit it entirely. Example: <UNIQUENUM>400325001</UNIQUENUM> (numeric at RIT) Example: <UNIQUENUM>BIO2010 02</UNIQUENUM> (alphanumeric at Elmira)

	<INSTRUCTOR></INSTRUCTOR>
	OPTIONAL This is the professor instructing this section of the course. If there is more than one instructor, you may use more than one instructor tag. Please do not put both names in the same tag! (as always, line-breaks between tags are optional) Example: <INSTRUCTOR>Jon Smith</INSTRUCTOR><INSTRUCTOR>Jane Smith</INSTRUCTOR>

	<CREDITS></CREDITS>
	OPTIONAL Generally this means credit-hours, but some schools (such as Harvard) use different systems. Regardless, if you have an acceptable value available, please pass it in as a decimal or integer. Maximum of 2 digits before the decimal point and 2 digits after it. Example: <CREDITS>4</CREDITS>

	<ISLAB></ISLAB>
	OPTIONAL This is a boolean value, it should be true if this section is a lab. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. Example: <ISLAB>1</ISLAB> Example: <ISLAB>true</ISLAB> Example: <ISLAB>false</ISLAB>

	<ISONLINE></ISONLINE>
	OPTIONAL This is a boolean value, it should be true if this section is an online course. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. Example: <ISONLINE>1</ISONLINE> Example: <ISONLINE>true</ISONLINE> Example: <ISONLINE>false</ISONLINE>

	<ISEVENING></ISEVENING>
	OPTIONAL This is a boolean value, it should be true if this section is an evening course. If this tag is not found or is left blank, it will default to false. Both 1 and true (not case-sensitive) will be considered as a "true", all other values will fall back to the default. If you don't have this data available for courses at your school, just ignore this field entirely; it will not cause any negative side effects. Example: <ISEVENING>1</ISEVENING> Example: <ISEVENING>true</ISEVENING> Example: <ISEVENING>false</ISEVENING>

	<SECTIONINFO></SECTIONINFO>
	OPTIONAL This space can be used to put extra notes on the section. This should not be used for a description of the course, that belongs in COURSEINFO. HTML will not be shown (for security reasons), so a hyperlink passed in here wouldn't be an actual link but would instead display the <a href=... > etc. If your line-breaks are represented as <BR>, those will still work because they will be converted when they are received. If your line-breaks are already \n's, and outputting them would result in this text being on multiple lines, that is also acceptable. Only leading and trailing whitespace will be deleted. If you need to make links to another course use this format: [course link=fieldNum,courseNum,sectionNum]CS 250[/course] leaving the sectionNum blank if you mean a whole course regardless of section. If you mean a specific section and you have a uniqueNum available, you can also use this: [course uniqueNum=uniqueNum]Comp Sci[/course] To get a better idea of this, see the example. The maximum length for this value is 65,535 characters. Example: <SECTIONINFO>This section has an ASL Interpreter</SECTIONINFO>

<MEETING>

	<DAYS></DAYS>
	This is a string of days from the options of "MTWRFSU" (representing monday through sunday respectively), of when there will be a meeting at this particular time and place NOTE: If the section meets in different places or at different times, please use multiple MEETINGs to represent this. So if a course met on Monday and Wednesday at one location and Teusday and Thursday at another location, you would need two MEETINGs (not one or four). Example: <DAYS>MWF</DAYS>

	<TIMESTART></TIMESTART>
	The time that the course starts. This should be hours and minutes (HH:MM), no seconds. Military time is recommended, but if an "am", "pm", "a", or "p" are detected, those will be used to generate the military time. You can use whichever format is in your database or is easier for you to send. Example: <TIMESTART>14:00</TIMESTART>

	<TIMEEND></TIMEEND>
	The time that the course ends. This should be hours and minutes (HH:MM), no seconds. Military time is recommended, but if an "am", "pm", "a", or "p" are detected, those will be used to generate the military time. You can use whichever format is in your database or is easier for you to send. Example: <TIMEEND>14:50</TIMEEND>

	<BUILDING></BUILDING>
	OPTIONAL The building that this particular meeting will be in. If there is more than one building, then you should use more than one set of MEETING tags. At many schools a number will suffice (recommended if possible), but if your school does not have numbers, other strings will work as well. Single and double quotes are not permitted. Example: <BUILDING>George Eastman Building</BUILDING> Example: <BUILDING>70</BUILDING> NOTE: these are different examples. The same meeting can not have multiple buildings: use multiple meetings to represent different places.

	<ROOM></ROOM>
	OPTIONAL The room that this particular meeting will be in. If there is more than one room, then you should use more than one set of MEETING tags. Numbers, as well as other strings work fine. Single and double quotes are not permitted. Example: <ROOM>1337</ROOM> Example: <ROOM>Colombo Auditorium</ROOM> NOTE: these are different examples. The same meeting can not have multiple rooms: use multiple meetings to represent different places.

</MEETING>
</SECTION>
</COURSE>
</FIELD>
</TERM>

If you want to set the field icons manually in a seperate part of the file, but you generate the rest of the fields automatically, you may find it useful to use this structure to set the icons:
<ICON>

	<FIELDNUM></FIELDNUM>
	The field number that was specified either in a FIELD as above or in the full heirarchy of TERM shown below Example: <FIELDNUM>0101</FIELDNUM> (numbers at RIT) Example: <FIELDNUM>ECON</FIELDNUM> (strings at PSU)

	<FIELDICON></FIELDICON>
	This field is the name of the icon found on the field icons page. It is not case-sensitive. If no value is specified for this field, the default icon will be used. Example: <FIELDICON>ENGINEERING</FIELDICON>

</ICON>


[EXPAND ALL]   [COLLAPSE ALL]

Back to API Page