Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Sample Request Header
- =====================
- content-type: {text/xml}, {application/json}
- authentication-key: {key-value}
- REST API Methods
- ================
- Project Methods
- * projects
- URL: /projects.format
- Formats: xml, json, rss, atom
- HTTP Method: GET
- Requires Authentication: true
- Parameters:
- * page, Optional, Specifies the page of projects list to retrieve
- Example: /projects.json?page=3
- Response:
- XML example:
- <?xml version="1.0" encoding="UTF-8"?>
- <projects>
- <project>
- <id>111</id>
- <title>Some tile</title>
- <description>some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- <project>
- <id>112</id>
- <title>AgainSome tile</title>
- <description>again some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- </projects>
- JSON example:
- [
- {
- "title": "some title",
- "id": 111,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- },
- {
- "title": "again some title",
- "id": 112,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "again some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- }
- ]
- * projects/new
- URL: /projects/new.format
- Formats: xml, json
- HTTP method: POST
- Require Authentication: true
- Parameters:
- title, Required.
- description, optional
- Response:
- XML example:
- <?xml version="1.0" encoding="UTF-8"?>
- <project>
- <id>111</id>
- <title>Some tile</title>
- <description>some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- JSON example:
- {
- "title": "some title",
- "id": 111,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- }
- * projects/{id}
- URL: /projects/{id}.format
- Formats: xml, json, rss, atom
- HTTP method: GET
- Require Authentication: true
- Parameters:
- id, Required.
- Response:
- XML example:
- <?xml version="1.0" encoding="UTF-8"?>
- <project>
- <id>111</id>
- <title>Some tile</title>
- <description>some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- JSON example:
- {
- "title": "some title",
- "id": 111,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- }
- * projects/edit/{id}
- URL: /projects/edit/{id}.format
- Formats: xml, json
- HTTP method: POST
- Require Authentication: true
- Parameters:
- id, Required.
- Response:
- XML example:
- <?xml version="1.0" encoding="UTF-8"?>
- <project>
- <id>111</id>
- <title>Some tile</title>
- <description>some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- JSON example:
- {
- "title": "some title",
- "id": 111,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- }
- * projects/delete/{id}
- URL: /projects/delete/{id}.format
- Formats: xml, json
- HTTP method: POST
- Require Authentication: true
- Parameters:
- id, Required.
- Response:
- XML example:
- <?xml version="1.0" encoding="UTF-8"?>
- <project>
- <id>111</id>
- <title>Some tile</title>
- <description>some description</description>
- <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
- <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
- </project>
- JSON example:
- {
- "title": "some title",
- "id": 111,
- "created_date": "Tue Apr 07 22:52:51 +0000 2009",
- "description": "some description",
- "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
- }
Add Comment
Please, Sign In to add comment