{|align="right"
|-
| __TOC__
|}

<img src="http://coldbox.org/includes/images/ForgeBox.png" style="float:left;margin-right:5px" />
[http://www.coldbox.org/forgebox ForgeBox] is a source directory for anything ColdBox or [http://www.codexwiki.org CodexWiki].  We also have a community development website called the [http://coldbox.assembla.com/spaces/coldbox-community 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.

<br/>
<br/>

== API EntryPoint ==
The ForgeBox API entry point is:

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


== Available Formats ==
The available return formats are: 
* xml (default)
* json

The format is attached after the API endpoint.

=== XML Endpoint ===
<pre>
http://www.coldbox.org/api/forgebox/xml/
</pre>

=== JSON Endpoint ===
<pre>
http://www.coldbox.org/api/forgebox/json/
</pre>

You can also check out our [[ForgeBox:HTTP-Response-Codes| 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:

<source lang="javascript">
{ error:true, messages:"invalid return format", data="" }
</source>

XML Example:
<source lang="xml">
<forgebox>
  <error>true</error>
  <messages>Invalid Return Format</messages>
  <data />
</forgebox>
</source>

== Methods ==
The following are available ForgeBox API methods

=== Types API Methods ===
* [[ForgeBox:types|types]] - Retrieve all entry types

=== Entries API Methods ===
* [[ForgeBox:entries|entries]] - Retrieve entries with criteria
* [[ForgeBox:entries-popular|entries/popular]] - Retrieve the most popular entries
* [[ForgeBox:entries-new|entries/new]] - Retrieve the newest contributed entries
* [[ForgeBox:entries-recent|entries/recent]] - Retrieve the most recent contributed entries
* [[ForgeBox:entry|entry/:slug]] - Retrieving an entry