test.md

Meta

     API Documentation, generated 2011-06-22T16:54:50+01:00
     Actions      : 6
     Errors       : 4
     Output Types : 8

Actions

Collection

Description

This is an example of a collection. A collection is a bucket of resources. In this case, you can only POST and DELETE this collection.

POST: A post will add a new resource to a collection. You have to pass a "name" parameter.

DELETE: Delete collection will remove the collection of resources from the system.

Try it with "curl -X POST http://api.frapi/collection -d '{"name":"new"}' -H 'Content-Type: application/json'

URL

• /collection

Parameters

• name (Optional)

Resource

Description

This is the resource contained in a certain collection group.

PUT: A put with the "name" parameter will update the name of the resource

DELETE: Deletes the resource.

GET: This retrieves the information relative to the resource contained in the collection

URL

• /collection/:resource

Parameters

• name (Optional)

Siblings

Description

This is a collection of sibling for a resource. This only accepts POST, DELETE, GET and HEAD.

POST: A post will add a new sibling using the name parameter

DELETE: This deletes the siblings connections, it removes all siblings in the collection

GET: Retrieve a list of siblings and the relative information.

HEAD: Fetch the meta information for the siblings.

URL

• /collection/:resource/siblings

Parameters

• name (Optional)

Sibling

Description

This is used to execute operations on a sibling resource.

GET: Retrieve the information relative to a sibling

DELETE: Remove a sibling for this resource

HEAD: Retrieve the meta information relative to a sibling.

URL

• /collection/:resource/siblings/:sibling

No parameters associated to this action

Tekdemos

Description

IM a currently giving a talk on demoing frapi and talking about frapi.

URL

• /tek/demo

Parameters

• baptiboupti (Required)

Microsoft

Description

This is a Microsoft event.

PUT: Add attendees POST: update DELETE...

URL

• /event/microsoft

No parameters associated to this action

Errors

NO_PUT

HTTP Response Code

405

Developers Message (Sent back to the developers)

This method is not accepted for this API call.

Error Description

This error is returned whenever someone tries to execute a PUT request on a collection or a resource that prevents PUT requests.

NO_POST

HTTP Response Code

405

Developers Message (Sent back to the developers)

POST calls are not accepted for this request.

Error Description

This error is returned whenever a collection or a resource prevents the use of the POST method.

NOT_TRUE

HTTP Response Code

406

Developers Message (Sent back to the developers)

This is not true

Error Description

This is the error returned when a string pass isn't true.

TEK_ERROR

HTTP Response Code

419

Developers Message (Sent back to the developers)

Some example.

Error Description

this is an error returned whenever we're at tek.

Output Types

• CLI (Enabled)

• PHP (Enabled)

• XML (Enabled)

• JSON (Enabled) and this one is the Default output type

• PRINTR (Enabled)

• Custom (Enabled)

• HTML (Enabled)

• JS (Enabled)

Frapi, echolibre ltd.