Help
URL Syntax

All frames, components and resources can be accessed via a URL. Below are the descriptions of the kinds of URLs that you can use. Use these URLs to show frames, components, or resources in their own windows or in an iframe HTML element in an external website. You can also use these URLs for navigation between content inside BrainHoney.

Standalone Component

Use this type of URL to display a standalone component. The component names are any of the standard components described in Components.

Syntax:

/Component/<ComponentName>?<ComponentParameters>

Example:

http://myschool.brainhoney.com/Component/ActivityPlayer?enrollmentid=1234&itemid=QUIZ

Standalone Resource

Use this type of URL to display a standalone resource. The entity ID in a resource URL is the domain ID of the domain where the resource is stored. You may also use the <resourcebase> tag in your domain customization to have your domain point to another domain’s resources. See Customization XML for more information.

Syntax:

/Resource/<EntityId>/<PathToResource>?<ResourceParameters>

Example:

http://myschool.brainhoney.com/Resource/89/custom.vhtml?view=full

Frame with Content

Use this type of URL to display a frame with a component or resource as its main content. If the frame type is omitted from the URL, the default frame is used. You can define and register your own frames or override the default frame in your domain customization. See Customization XML for more information.

Syntax:

/Frame/[<FrameType>]/Component/<ComponentName>?<ComponentParameters>

OR

/Frame/[<FrameType>]/Resource/<EntityId>/<PathToResource>?<ResourceParameters>

Examples:

/Frame/default/Component/ActivityPlayer?enrollmentid=1234&itemid=QUIZ

/Frame/Resource/89/custom.vhtml?view=full

Raw Component

Use this type of URL to get the raw HTML of a component. The component names are any of the standard components described in Components. This URL style is not commonly used and should only be used when making dynamic AJAX calls to load components or trying to host components in an external web site without the use of iframes. The component returned from the Raw Component URL still assumes the existence of the Frame API on the containing HTML page. If it is not already there from other components on the page, the page hosting the raw component must supply it using the FrameAPI component or raw component.

Syntax:

/RawComponent/<ComponentName>?<ComponentParameters>

Example:

http://myschool.brainhoney.com/RawComponent/ActivityPlayer?enrollmentid=1234&itemid=QUIZ

See Also
Customization XML FrameApi Hosting Components in an External Web Site