index
API OVERVIEW
AUTHENTICATION
API PROTOCOL
API DATA
- Recipes
- Recipe Reviews
- Recipe Images
- Recipe Search Results
- Food Glossary
- Favorites
- Try Soons
- Grocery List
- User Profile
DATA MANAGEMENT
BRANDING, LEGAL & FINANCIAL
Recipe Reviews
The Recipe Review object refers to a review of a recipe within the BigOven collection. The following methods are supported for the Recipe Review object. For most of these requests, you'll need to pass in the authentication information for the user in question.
| CREATE | READ | UPDATE | DELETE | |
| Recipe Review | Yes | Yes | Yes | Yes |
Creating a Recipe Review (HTTP POST)
Create a new review for an existing recipe.
POST http://api.bigoven.com/reviews?
| Parameter | Description | Required? |
| rid | Primary key(ID) of recipe. | Yes |
| rating | User rating for recipe in {1,2,3,4,5} | Yes |
| makeagain | Would user make again? One of {yes, no, notmake} | Yes |
| message | Review comment body | Yes |
| totaltime | Total time required for creation | No |
| activetime | Active time required for creation | No |
Reading a Recipe Review (HTTP GET)
Read a single recipe review.
GET http://api.bigoven.com/review/{id}
| Parameter | Description | Required? |
| id | Primary key(ID) of recipe review. | Yes |
Read all recipe reviews for a given recipe.
GET http://api.bigoven.com/reviews?rid={recipeid}
| Parameter | Description | Required? |
| rid | Primary key(ID) of recipe. | Yes |
Updating a Recipe Review (HTTP PUT)
Update a recipe review with a given primary key value (ID).
PUT http://api.bigoven.com/review/{id}
| Parameter | Description | Required? |
| rid | Primary key(ID) of recipe. | Yes |
| rating | User rating for recipe in {1,2,3,4,5} | Yes |
| makeagain | Would user make again? One of {yes, no, notmake} | Yes |
| message | Review comment body | Yes |
| totaltime | Total time required for creation | No |
| activetime | Active time required for creation | No |
Deleting a Recipe Review (HTTP DELETE)
Delete a recipe review with a given primary key value (ID).
DELETE http://api.bigoven.com/review/{id}
| Parameter | Description | Required? |
| id | Primary key(ID) of recipe review. | Yes |
