-
Notifications
You must be signed in to change notification settings - Fork 2
Catalog Detail
GeoLearning edited this page Sep 14, 2010
·
7 revisions
The Catalog Detail API allows for viewing advanced detailed information about a catalog item.
- URL: http://services.geolearning.com/api/{domain}/Catalog/{Primary Catalog Type}/{Id of Item}
- Open Site: http://services.geolearning.com/api/{domain}/Open/Catalog/{Primary Catalog Type}/{Id of Item}
| Reference | Destination |
|---|---|
| self | The link for the current feed |
| internal | A link to the resource within the Maestro GUI |
| login-url | A URI that passes through the login process and then launches the resource after authentication |
| Tag | Value Description |
|---|---|
| geo:PrimaryCatalogType | One of Course, IltClass, OnlineResource, Bundle |
| geo:SecondaryCatalogType | A more specific listing of the object type if available. For example online resources list the exact resource type (i.e. PDF,PNG, etc.). |
| Tag | Value Description |
|---|---|
| geo:Code | The course code. |
| geo:Duration | Duration set by the item. |
| geo:Vendor | The name of the course’s vendor if available. |
| geo:Cost | The cost of the item in US dollars if it has one. In the authenticated feed this will be adjusted with group discounts for the user accessing the feed. |
| geo:CeuCredits | Total number of Ceu Credit Hours listed on the item. Bundles display the sum of the Ceu’s for each course they contain. |
| geo:TestRequiredToComplete | A boolean designating if this item must have a maestro test completed in order to be finished. |
| geo:CertificateAvailable | A boolean designating if a completion certificate is available for this course. |
| geo:IsFeatured | A boolean designating if this course has been marked as featured. |
| geo:ExternalUrl | A external URL attached to the course. |
| geo:category | A category element will be present for each associated course category. |
| geo:Prerequisite | A prerequisite element will be present for each prerequisite a course has. Each element list the name of the course. |
Custom Course Attributes
Custom course attributes associated to a course will each appear as their own extension element. Because these element names must also be valid XML, the names are formatted to meet with XML requirements.
| Tag | Value Description |
|---|---|
| geo:Code | The classes code. |
| geo:Duration | Duration set by the class’s course. |
| geo:Vendor | The name of the class’s course’s vendor if available. |
| geo:Cost | The cost of the class’s course in US dollars if it has one. In the authenticated feed this will be adjusted with group discounts for the user accessing the feed. |
| geo:CeuCredits | Total number of Ceu Credit Hours listed on the class’s course. Bundles display the sum of the Ceu’s for each course they contain. |
| geo:category | A category element will be present for each associated course category. |
| geo:ClassContact | The class contact, if one is listed. |
| geo:ClassContactPhone | The class contact phone number, if listed |
| geo:StartDate | The start datetime of the first session of the class. Listed in UTC |
| geo:Session | An entry for each session that is part of the class. The element lists the start and end datetimes in UTC for each session |
| geo:Prerequisite | A prerequisite element will be present for each prerequisite a class’s course has. Each element list the name of the course. |
| geo:Course | The name of the class’s course |
The Catalog Detail API allows for viewing advanced detailed information about a catalog item.
- URL: http://services.geolearning.com/api/{domain}/Catalog/{Primary Catalog Type}/{Id of Item}
- Open Site: http://services.geolearning.com/api/{domain}/Open/Catalog/{Primary Catalog Type}/{Id of Item}
| Reference | Destination |
|---|---|
| self | The link for the current feed |
| internal | A link to the resource within the Maestro GUI |
| login-url | A URI that passes through the login process and then launches the resource after authentication |
| Tag | Value Description |
|---|---|
| geo:PrimaryCatalogType | One of Course, IltClass, OnlineResource, Bundle |
| geo:SecondaryCatalogType | A more specific listing of the object type if available. For example online resources list the exact resource type (i.e. PDF,PNG, etc.). |
| Tag | Value Description |
|---|---|
| geo:Code | The course code. |
| geo:Duration | Duration set by the item. |
| geo:Vendor | The name of the course’s vendor if available. |
| geo:Cost | The cost of the item in US dollars if it has one. In the authenticated feed this will be adjusted with group discounts for the user accessing the feed. |
| geo:CeuCredits | Total number of Ceu Credit Hours listed on the item. Bundles display the sum of the Ceu’s for each course they contain. |
| geo:TestRequiredToComplete | A boolean designating if this item must have a maestro test completed in order to be finished. |
| geo:CertificateAvailable | A boolean designating if a completion certificate is available for this course. |
| geo:IsFeatured | A boolean designating if this course has been marked as featured. |
| geo:ExternalUrl | A external URL attached to the course. |
| geo:category | A category element will be present for each associated course category. |
| geo:Prerequisite | A prerequisite element will be present for each prerequisite a course has. Each element list the name of the course. |
Custom Course Attributes
Custom course attributes associated to a course will each appear as their own extension element. Because these element names must also be valid XML, the names are formatted to meet with XML requirements.
| Tag | Value Description |
|---|---|
| geo:Code | The bundles code. |
| geo:Duration | The sum of the durations of all courses that are part of the bundle. |
| geo:CeuCredits | The sum of the Ceu Credits of all courses that are part of the bundle. |
| geo:Cost | The cost of the bundle in US dollars if it has one. In the authenticated feed this will be adjusted with group discounts for the user accessing the feed. |
| geo:Course | One course element will exist for each course associated with the bundle. |