Contents API EntryPoint Available Formats XML Endpoint JSON Endpoint Return Structure Methods Types API Methods Entries API Methods

ForgeBox is a source directory for anything ColdBox or CodexWiki. We also have a community development website called the ColdBox Community Space where we can host your projects in either git/svn/files with tons of cool collaboration and development tools. The following is the API documentation for ForgeBox's REST service.

API EntryPoint

The ForgeBox API entry point is:

http://www.coldbox.org/api/forgebox/{format}/{resource-method}

Available Formats

The available return formats are:

• xml (default)
• json

The format is attached after the API endpoint.

XML Endpoint

http://www.coldbox.org/api/forgebox/xml/

JSON Endpoint

http://www.coldbox.org/api/forgebox/json/

You can also check out our HTTP Response Codes.

Return Structure

All ForgeBox REST API calls have the same return structure in order to provide consistency.

• forgebox
  • error : boolean
  • messages : string
  • data : records

JSON Example:

{ error:true, messages:"invalid return format", data="" }

XML Example:

<forgebox>
  <error>true</error>
  <messages>Invalid Return Format</messages>
  <data />
</forgebox>

Methods

The following are available ForgeBox API methods

Types API Methods

• types - Retrieve all entry types

Entries API Methods

• entries - Retrieve entries with criteria
• entries/popular - Retrieve the most popular entries
• entries/new - Retrieve the newest contributed entries
• entries/recent - Retrieve the most recent contributed entries
• entry/:slug - Retrieving an entry