6.0.0 • Published 5 years ago

@datafire/bigoven v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/bigoven

Client library for BigOven

Installation and Usage

npm install --save @datafire/bigoven
let bigoven = require('@datafire/bigoven').create({
  api_key: "",
  username: "",
  password: ""
});

.then(data => {
  console.log(data);
});

Description

#Documentation

This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API.

The update brings with it Swagger-based documentation. Swagger is an emerging standard for describing REST-based APIs, and with this Swagger-compliant endpoint (above), you can make ready-to-go interface libraries for your code via swagger-codegen. For instance, it's easy to generate libraries for Node.js, Java, Ruby, ASP.NET MVC, jQuery, php and more!

You can also try out the endpoint calls with your own api_key right here on this page. Be sure to enter your api_key above to use the "Try it out!" buttons on this page.

##Start Here

Developers new to the BigOven API should start with this version, not with the legacy API. We'll be making improvements to this API over time, and doing only bug fixes on the v1 API.

To pretend you're a BigOven user (for instance, to get your recently viewed recipes or your grocery list), you need to pass in Basic Authentication information in the header, just as with the v1 API. We do now require that you make all calls via https. You need to pass your api_key in with every call, though this can now be done on the header (send a request header "X-BigOven-API-Key" set to your api_key value, e.g., Request"X-BigOven-API-Key"="your-key-here".)

##Migration Notes

For existing partners, we encourage you to migrate, and while at this writing we have no hard-and-fast termination date for the v1 API, we strongly prefer that you migrate by January 1, 2017. While the changes aren't overly complex, there are several breaking changes, including refactoring of recipe search and results and removal of support for XML. This is not a simply plug-and-play replacement to the v1 API. With respect to an exclusive focus on JSON, the world has spoken, and it prefers JSON for REST-based API's. We've taken numerous steps to refactor the API to make it more REST-compliant. Note that this v2 API will be the preferred API from this point onward, so we encourage developers to migrate to this new format. We have put together some migration notes that we encourage you to read carefully.

##Photos

See our photos documentation.

For more information on usage of this API, including features, pricing, rate limits, terms and conditions, please visit the BigOven API website.

Actions

Article_Get

Get a food article

bigoven.Article_Get({
  "term": ""
}, context)

Input

  • input object
    • term required string

Output

Output schema unknown

Article_Put

Update the article by term

bigoven.Article_Put({
  "term": "",
  "data": {}
}, context)

Input

Output

Output schema unknown

Collection_GetCollection

Gets a recipe collection. A recipe collection is a curated set of recipes.

bigoven.Collection_GetCollection({
  "id": 0
}, context)

Input

  • input object
    • id required integer: the collection identifier
    • rpp integer: results per page
    • pg integer: page number (starting with 1)
    • test boolean
    • sessionForLogging string

Output

Collection_GetCollectionMeta

Gets a recipe collection metadata. A recipe collection is a curated set of recipes.

bigoven.Collection_GetCollectionMeta({
  "id": 0
}, context)

Input

  • input object
    • id required integer: the collection identifier

Output

Collection_Collections

Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections.

bigoven.Collection_Collections({}, context)

Input

  • input object
    • test string

Output

Glossary_ByTerm

Get food glossary article by term (e.g., asparagus). This editorial is (c) BigOven and MUST carry attribution and a link back to the glossary entry on BigOven.com.

bigoven.Glossary_ByTerm({
  "term": ""
}, context)

Input

  • input object
    • term required string: Keyword used to look up article, e.g., asparagus

Output

Glossary_Get

DEPRECATED. Please use "Article", which is a new format for food glossary articles, which separates out the images.

bigoven.Glossary_Get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: identifier of article to retrieve

Output

Output schema unknown

GroceryList_Delete

Delete all the items on a grocery list; faster operation than a sync with deleted items.

bigoven.GroceryList_Delete(null, context)

Input

This action has no parameters

Output

GroceryList_Get

Get the user's grocery list. User is determined by Basic Authentication.

bigoven.GroceryList_Get(null, context)

Input

This action has no parameters

Output

GroceryList_GroceryListRemoveMarkedItems

Clears the checked lines.

bigoven.GroceryList_GroceryListRemoveMarkedItems(null, context)

Input

This action has no parameters

Output

GroceryList_Department

Departmentalize a list of strings -- used for ad-hoc grocery list item addition

bigoven.GroceryList_Department({
  "model": {}
}, context)

Input

Output

grocerylist.item.post

Add a single line item to the grocery list

bigoven.grocerylist.item.post({
  "newItem": {}
}, context)

Input

Output

GroceryList_DeleteItemByGuid

/grocerylist/item/{guid} DELETE will delete this item assuming you own it.

bigoven.GroceryList_DeleteItemByGuid({
  "guid": ""
}, context)

Input

  • input object
    • guid required string

Output

GroceryList_GroceryListItemGuid

Update a grocery item by GUID

bigoven.GroceryList_GroceryListItemGuid({
  "req": {},
  "guid": ""
}, context)

Input

Output

grocerylist.line.post

Add a single line item to the grocery list

bigoven.grocerylist.line.post({
  "newItem": {}
}, context)

Input

Output

GroceryList_AddRecipe

Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the recipe the same size as originally posted), markAsPending (true/false) to indicate that the lines in the recipe should be marked in a "pending" (unconfirmed by user) state.

bigoven.GroceryList_AddRecipe({
  "data": {}
}, context)

Input

Output

GroceryList_PostGroceryListSync

Synchronize the grocery list. Call this with a POST to /grocerylist/sync

bigoven.GroceryList_PostGroceryListSync({
  "req": {}
}, context)

Input

Output

Images_UploadUserAvatar

POST: /image/avatar

        Testing with Postman (validated 11/20/2015):
        1) Remove the Content-Type header; add authentication information
        2) On the request, click Body and choose "form-data", then add a line item with "key" column set to "file" and on the right,
        change the type of the input from Text to File.  Browse and choose a JPG.
bigoven.Images_UploadUserAvatar(null, context)

Input

This action has no parameters

Output

Me_Index

Indexes this instance.

bigoven.Me_Index(null, context)

Input

This action has no parameters

Output

me.put

Puts me.

bigoven.me.put({
  "req": {}
}, context)

Input

Output

Me_PutMePersonal

Puts me personal.

bigoven.Me_PutMePersonal({
  "req": {}
}, context)

Input

Output

Me_PutMePreferences

Puts me preferences.

bigoven.Me_PutMePreferences({
  "req": {}
}, context)

Input

Output

Me_GetOptions

Gets the options.

bigoven.Me_GetOptions(null, context)

Input

This action has no parameters

Output

me.profile.put

Puts me.

bigoven.me.profile.put({
  "req": {}
}, context)

Input

Output

Me_Skinny

Skinnies this instance.

bigoven.Me_Skinny(null, context)

Input

This action has no parameters

Output

Recipe_Post

Add a new recipe

bigoven.Recipe_Post({
  "recipe": {}
}, context)

Input

Output

Recipe_Put

Update a recipe

bigoven.Recipe_Put({
  "recipe": {}
}, context)

Input

Output

Recipe_AutoComplete

Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.

bigoven.Recipe_AutoComplete({
  "query": ""
}, context)

Input

  • input object
    • query required string
    • limit integer

Output

  • output array
    • items string

Recipe_AutoCompleteAllRecipes

Automatics the complete all recipes.

bigoven.Recipe_AutoCompleteAllRecipes({
  "query": "",
  "limit": 0
}, context)

Input

  • input object
    • query required string: The query.
    • limit required integer: The limit.

Output

Recipe_AutoCompleteMyRecipes

Automatics the complete my recipes.

bigoven.Recipe_AutoCompleteMyRecipes({
  "query": "",
  "limit": 0
}, context)

Input

  • input object
    • query required string: The query.
    • limit required integer: The limit.

Output

Recipe_Categories

Get a list of recipe categories (the ID field can be used for include_cat in search parameters)

bigoven.Recipe_Categories(null, context)

Input

This action has no parameters

Output

Recipe_GetStep

Gets recipe single step as text

bigoven.Recipe_GetStep({
  "userName": "",
  "recipeId": 0,
  "stepId": 0
}, context)

Input

  • input object
    • userName required string
    • recipeId required integer
    • stepId required integer

Output

  • output string

Recipe_GetStepNumber

Returns stored step number and number of steps in recipe

bigoven.Recipe_GetStepNumber({
  "userName": "",
  "recipeId": 0
}, context)

Input

  • input object
    • userName required string
    • recipeId required integer

Output

Images_GetPendingByUser

Gets the pending by user.

bigoven.Images_GetPendingByUser(null, context)

Input

This action has no parameters

Output

Recipe_GetSteps

Stores recipe step number

bigoven.Recipe_GetSteps({
  "userName": "",
  "recipeId": 0,
  "stepId": 0
}, context)

Input

  • input object
    • userName required string
    • recipeId required integer
    • stepId required integer

Output

Review_DeleteReply

DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.

bigoven.Review_DeleteReply({
  "replyId": ""
}, context)

Input

  • input object
    • replyId required string

Output

Review_PutReply

Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.

bigoven.Review_PutReply({
  "replyId": "",
  "data": {}
}, context)

Input

Output

recipe.review.reviewId.get

Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount. Recommended display is to list top-level reviews with one featured reply underneath. Currently, the FeaturedReply is the most recent one for that rating.

bigoven.recipe.review.reviewId.get({
  "reviewId": ""
}, context)

Input

  • input object
    • reviewId required string

Output

Review_Put

Update a given top-level review.

bigoven.Review_Put({
  "reviewId": "",
  "review": {}
}, context)

Input

Output

Review_GetReplies

Get a paged list of replies for a given review.

bigoven.Review_GetReplies({
  "reviewId": ""
}, context)

Input

  • input object
    • reviewId required string
    • pg integer: the page (int), starting with 1
    • rpp integer: results per page (int)

Output

Review_PostReply

POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, only top-level reviews do.

bigoven.Review_PostReply({
  "reviewId": "",
  "data": {}
}, context)

Input

Output

Recipe_Scan

POST an image as a new RecipeScan request 1) Fetch the filename -- DONE 2) Copy it to the pics/scan folder - ENSURE NO NAMING COLLISIONS -- DONE 3) Create 120 thumbnail size in pics/scan/120 -- DONE 4) Insert the CloudTasks record 5) Create the HIT 6) Update the CloudTasks record with the HIT ID 7) Email the requesing user 8) Call out to www.bigoven.com to fetch the image and re-create the thumbnail

bigoven.Recipe_Scan({}, context)

Input

  • input object
    • test boolean
    • devicetype string
    • lat number
    • lng number

Output

Output schema unknown

Recipe_GetRecipeWithSteps

Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.

bigoven.Recipe_GetRecipeWithSteps({
  "id": 0
}, context)

Input

  • input object
    • id required integer: the Recipe ID to retrieve
    • prefetch boolean

Output

Recipe_Delete

Delete a Recipe (you must be authenticated as an owner of the recipe)

bigoven.Recipe_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

Recipe_Get

Return full Recipe detail. Returns 403 if the recipe is owned by someone else.

bigoven.Recipe_Get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: the Recipe ID to retrieve
    • prefetch boolean

Output

Recipe_ZapRecipe

Zaps the recipe.

bigoven.Recipe_ZapRecipe({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The identifier.

Output

Recipe_Feedback

Feedback on a Recipe -- for internal BigOven editors

bigoven.Recipe_Feedback({
  "recipeId": 0,
  "data": {}
}, context)

Input

Output

Images_UploadRecipeImage

POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption

         Note that caption, lng and lat are all optional, but must go on the request URI as params because this endpoint
         needs a multipart/mime content header and will not parse JSON in the body along with it.
        
         Testing with Postman (validated 11/20/2015):
         1) Remove the Content-Type header; add authentication information
         2) On the request, click Body and choose "form-data", then add a line item with "key" column set to "file" and on the right,
         change the type of the input from Text to File.  Browse and choose a JPG.
bigoven.Images_UploadRecipeImage({
  "recipeId": ""
}, context)

Input

  • input object
    • recipeId required string
    • caption string
    • lat number
    • lng number

Output

Images_Get

Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.

bigoven.Images_Get({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer: Recipe ID (required)

Output

Note_Post

HTTP POST a new note into the system.

bigoven.Note_Post({
  "recipeId": 0,
  "note": {}
}, context)

Input

Output

Note_Delete

Delete a review do a DELETE Http request of /note/{ID}

bigoven.Note_Delete({
  "recipeId": 0,
  "noteId": 0
}, context)

Input

  • input object
    • recipeId required integer: recipeId (int)
    • noteId required integer: noteId (int)

Output

Note_Get

Get a given note. Make sure you're passing authentication information in the header for the user who owns the note.

bigoven.Note_Get({
  "recipeId": 0,
  "noteId": 0
}, context)

Input

  • input object
    • recipeId required integer: recipe identifier (integer)
    • noteId required integer: The note ID (note -- it's not the RecipeID)

Output

Note_Put

HTTP PUT (update) a Recipe note (RecipeNote).

bigoven.Note_Put({
  "recipeId": 0,
  "noteId": 0,
  "recipeNote": {}
}, context)

Input

Output

Note_GetNotes

recipe/100/notes

bigoven.Note_GetNotes({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer: recipeId (int)
    • pg integer: page (int, starting from 1)
    • rpp integer: recipeId

Output

Images_GetRecipePhotos

Get all the photos for a recipe

bigoven.Images_GetRecipePhotos({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer: Recipe ID (required)
    • pg integer
    • rpp integer

Output

Recipe_Related

Get recipes related to the given recipeId

bigoven.Recipe_Related({
  "recipeId": 0,
  "pg": 0,
  "rpp": 0
}, context)

Input

  • input object
    • recipeId required integer
    • pg required integer
    • rpp required integer

Output

recipe.recipeId.review.get

Get my review for the recipe {recipeId}, where "me" is determined by standard authentication headers

bigoven.recipe.recipeId.review.get({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer

Output

Review_Post

Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated.

bigoven.Review_Post({
  "recipeId": 0,
  "data": {}
}, context)

Input

Output

Review_Delete

Delete a review by recipeId and reviewId. DEPRECATED. Please see recipe/review/{reviewId} for the preferred method. (We are moving from an integer-based ID system to a GUID-style string-based ID system for reviews and replies.)

bigoven.Review_Delete({
  "reviewId": "",
  "recipeId": ""
}, context)

Input

  • input object
    • reviewId required string
    • recipeId required string

Output

recipe.recipeId.review.reviewId.get

Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage. Beginning in January 2017, BigOven moded from an integer-based ID system to a GUID-style string-based ID system for reviews and replies. We are also supporting more of a "Google Play" style model for Reviews and Replies. That is, there are top-level Reviews and then an unlimited list of replies (which do not carry star ratings) underneath existing reviews. Also, a given user can only have one review per recipe. Existing legacy endpoints will continue to work, but we strongly recommend you migrate to using the newer endpoints listed which do NOT carry the "DEPRECATED" flag.

bigoven.recipe.recipeId.review.reviewId.get({
  "reviewId": 0,
  "recipeId": 0
}, context)

Input

  • input object
    • reviewId required integer: int
    • recipeId required integer: int

Output

Review_PutLegacy

HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint. We are moving to a string-based primary key system, no longer integers, for reviews and replies.

bigoven.Review_PutLegacy({
  "reviewId": 0,
  "review": {},
  "recipeId": 0
}, context)

Input

Output

Review_GetReviews

Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount.

bigoven.Review_GetReviews({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer: recipe id (int)
    • pg integer: the page (int), starting with 1
    • rpp integer: results per page (int)

Output

Images_GetScanImages

Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.

bigoven.Images_GetScanImages({
  "recipeId": 0
}, context)

Input

  • input object
    • recipeId required integer: the recipe identifier (int)

Output

Recipe_RecipeSearch

Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the parameter "include_primarycat" to one of (appetizers,bread,breakfast,dessert,drinks,maindish,salad,sidedish,soup,marinades,other). If you'd like to exclude a category, set exclude_cat to one or more (comma-separated) list of those categories to exclude. If you'd like to include a category, set include_cat to one or more (comma-separated) of those categories to include. To explicitly include an ingredient in your search, set the parameter "include_ing" to a CSV of up to three ingredients, e.g.:include_ing=mustard,chicken,beef%20tips To explicitly exclude an ingredient in your search, set the parameter "exclude_ing" to a CSV of up to three ingredients. All searches must contain the paging parameters pg and rpp, which are integers, and represent the page number (1-based) and results per page (rpp). So, to get the third page of a result set paged with 25 recipes per page, you'd pass pg=3&rpp=25 If you'd like to target searches to just a single target user's recipes, set userId=the target userId (number). Or, you can set username=theirusername vtn;vgn;chs;glf;ntf;dyf;sff;slf;tnf;wmf;rmf;cps cuisine photos filter=added,try,favorites,myrecipes\r\n\r\n folder=FolderNameCaseSensitive coll=ID of Collection

bigoven.Recipe_RecipeSearch({}, context)

Input

  • input object
    • any_kw string: Search anywhere in the recipe for the keyword
    • folder string: Search in a specific folder name for the authenticated user
    • coll integer: Limit to a collection ID number
    • filter string: optionally set to either "myrecipes", "try", "favorites","added" to filter to just the authenticated user's recipe set
    • title_kw string: Search just in the recipe title for the keyword
    • userId integer: Set the target userid to search their public recipes
    • username string: Set the target username to search their public recipes
    • token string
    • photos boolean: if set to true, limit search results to photos only
    • boostmine boolean: if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)
    • include_cat string: integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance, 58 is "Main Dish > Casseroles".
    • exclude_cat string: like include_cat, set this to an integer to exclude a specific category
    • include_primarycat string: csv indicating up to three top-level categories -- valid values are appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other
    • exclude_primarycat string: csv indicating integer values for up to 3 top-level categories -- valid values are 1...11 appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other
    • include_ing string: A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken
    • exclude_ing string: A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)
    • cuisine string: Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are Afghan,African,American,American-South,Asian,Australian,Brazilian,Cajun,Canadian,Caribbean,Chinese,Croatian,Cuban,Dessert,Eastern European,English,French,German,Greek,Hawaiian,Hungarian,India,Indian,Irish,Italian,Japanese,Jewish,Korean,Latin,Mediterranean,Mexican,Middle Eastern,Moroccan,Polish,Russian,Scandanavian,Seafood,Southern,Southwestern,Spanish,Tex-Mex,Thai,Vegan,Vegetarian,Vietnamese
    • db string
    • userset string: If set to a given username, it'll force the search to filter to just that username
    • servingsMin number: Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by "dozen", etc. This parameter simply specifies the minimum number for that value entered in "yield."
    • totalMins integer: Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert "1 hour, 15 minutes" to 75 before passing in.)
    • maxIngredients integer: Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less
    • minIngredients integer: Optional. If supplied, will restrict results to recipes that have at least {minIngredients}
    • rpp integer: integer; results per page
    • pg integer: integer: the page number
    • vtn integer: when set to 1, limit to vegetarian (Powersearch-capable plan required)
    • vgn integer: when set to 1, limit to vegan (Powersearch-capable plan required)
    • chs integer: when set to 1, limit to contains-cheese (Powersearch-capable plan required)
    • glf integer: when set to 1, limit to gluten-free (Powersearch-capable plan required)
    • ntf integer: when set to 1, limit to nut-free (Powersearch-capable plan required)
    • dyf integer: when set to 1, limit to dairy-free (Powersearch-capable plan required)
    • sff integer: when set to 1, limit to seafood-free (Powersearch-capable plan required)
    • slf integer: when set to 1, limit to shellfish-free (Powersearch-capable plan required)
    • tnf integer: when set to 1, limit to tree-nut free (Powersearch-capable plan required)
    • wmf integer: when set to 1, limit to white-meat free (Powersearch-capable plan required)
    • rmf integer: when set to 1, limit to red-meat free (Powersearch-capable plan required)
    • cps integer: when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)
    • champion integer: optional. When set to 1, this will limit search results to "best of" recipes as determined by various internal editorial and programmatic algorithms. For the most comprehensive results, don't include this parameter.
    • synonyms boolean: optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude bacon)

Output

Recipe_GetRandomRecipe

Get a random, home-page-quality Recipe.

bigoven.Recipe_GetRandomRecipe(null, context)

Input

This action has no parameters

Output

Recipe_Raves

Get the recipe/comment tuples for those recipes with 4 or 5 star ratings

bigoven.Recipe_Raves({}, context)

Input

  • input object
    • pg integer: page, starting with 1
    • rpp integer: results per page

Output

Recipe_RecentViews

Get a list of recipes that the authenticated user has most recently viewed

bigoven.Recipe_RecentViews({}, context)

Input

  • input object
    • pg integer: Page number starting with 1
    • rpp integer: results per page

Output

Recipe_RecipeSearchRandom

Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the parameter "include_primarycat" to one of (appetizers,bread,breakfast,dessert,drinks,maindish,salad,sidedish,soup,marinades,other). If you'd like to exclude a category, set exclude_cat to one or more (comma-separated) list of those categories to exclude. If you'd like to include a category, set include_cat to one or more (comma-separated) of those categories to include. To explicitly include an ingredient in your search, set the parameter "include_ing" to a CSV of up to three ingredients, e.g.:include_ing=mustard,chicken,beef%20tips To explicitly exclude an ingredient in your search, set the parameter "exclude_ing" to a CSV of up to three ingredients. All searches must contain the paging parameters pg and rpp, which are integers, and represent the page number (1-based) and results per page (rpp). So, to get the third page of a result set paged with 25 recipes per page, you'd pass pg=3&rpp=25 If you'd like to target searches to just a single target user's recipes, set userId=the target userId (number). Or, you can set username=theirusername vtn;vgn;chs;glf;ntf;dyf;sff;slf;tnf;wmf;rmf;cps cuisine photos filter=added,try,favorites,myrecipes\r\n\r\n folder=FolderNameCaseSensitive coll=ID of Collection

bigoven.Recipe_RecipeSearchRandom({}, context)

Input

  • input object
    • any_kw string: Search anywhere in the recipe for the keyword
    • folder string: Search in a specific folder name for the authenticated user
    • coll integer: Limit to a collection ID number
    • filter string: optionally set to either "myrecipes", "try", "favorites","added" to filter to just the authenticated user's recipe set
    • title_kw string: Search just in the recipe title for the keyword
    • userId integer: Set the target userid to search their public recipes
    • username string: Set the target username to search their public recipes
    • token string
    • photos boolean: if set to true, limit search results to photos only
    • boostmine boolean: if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)
    • include_cat string: integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance, 58 is "Main Dish > Casseroles".
    • exclude_cat string: like include_cat, set this to an integer to exclude a specific category
    • include_primarycat string: csv indicating up to three top-level categories -- valid values are appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other
    • exclude_primarycat string: csv indicating integer values for up to 3 top-level categories -- valid values are 1...11 appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other
    • include_ing string: A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken
    • exclude_ing string: A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)
    • cuisine string: Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are Afghan,African,American,American-South,Asian,Australian,Brazilian,Cajun,Canadian,Caribbean,Chinese,Croatian,Cuban,Dessert,Eastern European,English,French,German,Greek,Hawaiian,Hungarian,India,Indian,Irish,Italian,Japanese,Jewish,Korean,Latin,Mediterranean,Mexican,Middle Eastern,Moroccan,Polish,Russian,Scandanavian,Seafood,Southern,Southwestern,Spanish,Tex-Mex,Thai,Vegan,Vegetarian,Vietnamese
    • db string
    • userset string: If set to a given username, it'll force the search to filter to just that username
    • servingsMin number: Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by "dozen", etc. This parameter simply specifies the minimum number for that value entered in "yield."
    • totalMins integer: Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert "1 hour, 15 minutes" to 75 before passing in.)
    • maxIngredients integer: Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less
    • minIngredients integer: Optional. If supplied, will restrict results to recipes that have at least {minIngredients}
    • vtn integer: when set to 1, limit to vegetarian (Powersearch-capable plan required)
    • vgn integer: when set to 1, limit to vegan (Powersearch-capable plan required)
    • chs integer: when set to 1, limit to contains-cheese (Powersearch-capable plan required)
    • glf integer: when set to 1, limit to gluten-free (Powersearch-capable plan required)
    • ntf integer: when set to 1, limit to nut-free (Powersearch-capable plan required)
    • dyf integer: when set to 1, limit to dairy-free (Powersearch-capable plan required)
    • sff integer: when set to 1, limit to seafood-free (Powersearch-capable plan required)
    • slf integer: when set to 1, limit to shellfish-free (Powersearch-capable plan required)
    • tnf integer: when set to 1, limit to tree-nut free (Powersearch-capable plan required)
    • wmf integer: when set to 1, limit to white-meat free (Powersearch-capable plan required)
    • rmf integer: when set to 1, limit to red-meat free (Powersearch-capable plan required)
    • cps integer: when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)
    • champion integer: optional. When set to 1, this will limit search results to "best of" recipes as determined by various internal editorial and programmatic algorithms. For the most comprehensive results, don't include this parameter.
    • synonyms boolean: optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude bacon)

Output

Definitions

API2.Controllers.GroceryListController.DepartmentModel

  • API2.Controllers.GroceryListController.DepartmentModel object
    • items string: Gets or sets the items.

API2.Controllers.GroceryListController.PostGroceryListAddLineRequest

  • API2.Controllers.GroceryListController.PostGroceryListAddLineRequest object
    • text string: Gets or sets the text.

API2.Controllers.GroceryListController.PostGroceryListRecipeRequest

  • API2.Controllers.GroceryListController.PostGroceryListRecipeRequest object
    • markAsPending boolean: Gets or sets the mark as pending.
    • recipeId integer: Gets or sets the recipe identifier.
    • scale number: Gets or sets the scale.

API2.Controllers.GroceryListController.PostGroceryListSyncRequest

API2.Controllers.GroceryListController.PostToGroceryListRecipeRequest

  • API2.Controllers.GroceryListController.PostToGroceryListRecipeRequest object
    • department string: Gets or sets the department.
    • name string: Gets or sets the name.
    • notes string: Gets or sets the notes.
    • quantity string: Gets or sets the quantity.
    • unit string: Gets or sets the unit.

API2.Controllers.GroceryListController.UpdateItemByGuidRequest

  • API2.Controllers.GroceryListController.UpdateItemByGuidRequest object
    • department string: Gets or sets the department.
    • guid string: Gets or sets the unique identifier.
    • ischecked boolean: Gets or sets the ischecked.
    • name string: Gets or sets the name.
    • notes string: Gets or sets the notes.
    • quantity string: Gets or sets the quantity.
    • unit string: Gets or sets the unit.

API2.Controllers.ImagesController.RecipePhotosResponse

  • API2.Controllers.ImagesController.RecipePhotosResponse object
    • ResultCount integer: Gets or sets the result count.
    • Results array: Gets or sets the results.

API2.Controllers.MeController.EatingStyle

API2.Controllers.MeController.Option

  • API2.Controllers.MeController.Option object
    • Description string: Gets or sets the description.
    • Key string: Gets or sets the key.

API2.Controllers.MeController.PreferenceOptions

API2.Controllers.NoteController.NoteRequest

  • API2.Controllers.NoteController.NoteRequest object
    • CreationDate string: Gets or sets the creation date.
    • Date string: Gets or sets the date.
    • DateDT string: Gets or sets the date dt.
    • GUID string: Gets or sets the unique identifier.
    • ID integer: Gets or sets the identifier.
    • Notes string: Gets or sets the notes.
    • People string: Gets or sets the people.
    • RecipeID integer: Gets or sets the recipe identifier.
    • UserID integer: Gets or sets the user identifier.
    • Variations string: Gets or sets the variations.

API2.Controllers.RecipeController.FeedbackDTO

  • API2.Controllers.RecipeController.FeedbackDTO object
    • feedback string

API2.Controllers.ReviewController.PostReplyReq

  • API2.Controllers.ReviewController.PostReplyReq object: Reply request parameters
    • Comment string: The comment. If mentioning any user(s) (optional), include them as @username in the text body. Do not use @ symbol for anything but mentioning @usernames.

API2.Controllers.ReviewController.ReviewRequest

  • API2.Controllers.ReviewController.ReviewRequest object: Payload for reviews
    • ActiveMinutes integer: How many minutes of ACTIVE time (i.e., actively working on the recipe, not waiting for rising, baking, etc.) did it
    • Comment string: The notes
    • MakeAgain string: "yes" or "no"
    • StarRating integer: 1, 2, 3, 4, or 5
    • TotalMinutes integer: How long, start to finish, in minutes (integer) did it take? Optional.

API2.Controllers.ReviewController.ReviewRequestLegacy

  • API2.Controllers.ReviewController.ReviewRequestLegacy object: Legacy -- This object here is deprecated. Please use the new "ReviewRequest" structure for all future development
    • ActiveMinutes integer
    • Comment string
    • GUID string
    • MakeAgain string
    • ParentID integer
    • StarRating integer
    • TotalMinutes integer

API2.Controllers.WebAPI.ArticleController.PutArticleReq

  • API2.Controllers.WebAPI.ArticleController.PutArticleReq object: Update an article
    • definition string: the html definition

API2.GroceryListDepartmentResult

  • API2.GroceryListDepartmentResult object
    • dept string: Gets or sets the dept.
    • item string: Gets or sets the item.

API2.Models.Accounting

  • API2.Models.Accounting object
    • CreditBalance integer
    • MemberSince string
    • PremiumExpiryDate string
    • UserLevel string

API2.Models.BigOvenUser

API2.Models.Counts

  • API2.Models.Counts object
    • AddedCount integer
    • FollowersCount integer
    • FollowingCount integer
    • PrivateRecipeCount integer
    • PublicRecipeCount integer
    • TotalRecipes integer

API2.Models.Location

  • API2.Models.Location object
    • City string
    • Country string
    • DMA integer

API2.Models.Personal

  • API2.Models.Personal object: Personal level info -- email, location, etc.

API2.Models.Preference

  • API2.Models.Preference object
    • EatingStyle string

API2.Models.Profile

  • API2.Models.Profile object
    • AboutMe string
    • BackgroundUrl string
    • Counts API2.Models.Counts
    • FirstName string
    • FullName string
    • HomeUrl string
    • LastName string
    • PhotoUrl string
    • UserID integer
    • UserName string

BigOven.Model.API.GlossaryEntry

  • BigOven.Model.API.GlossaryEntry object
    • CreationDate string
    • Definition string
    • GlossaryEntryID integer
    • LastModified string
    • Term string

BigOven.Model.API.Grocery.GroceryList

BigOven.Model.API.Grocery.Item

  • BigOven.Model.API.Grocery.Item object
    • BigOvenObject string
    • CreationDate string
    • Department string
    • DisplayQuantity string
    • GUID string
    • IsChecked boolean
    • ItemID integer
    • LastModified string
    • LocalStatus string
    • Name string
    • Notes string
    • RecipeID integer
    • ThirdPartyURL string

BigOven.Model.API.Image

  • BigOven.Model.API.Image object
    • Caption string
    • CreationDate string
    • ImageID integer
    • ImageSquares array
      • items integer
    • ImageURL string
    • ImageURL120 string
    • ImageURL128 string
    • ImageURL200 string
    • ImageURL256 string
    • ImageURL48 string
    • ImageURL64 string
    • IsPrimary boolean
    • MaxImageSquare integer
    • Poster BigOven.Model.API.UserInfo

BigOven.Model.API.Ingredient

  • BigOven.Model.API.Ingredient object
    • DisplayIndex integer
    • DisplayQuantity string
    • HTMLName string
    • IngredientID integer
    • IngredientInfo BigOven.Model.API.IngredientInfo
    • IsHeading boolean
    • IsLinked boolean
    • MetricDisplayQuantity string
    • MetricQuantity number
    • MetricUnit string
    • Name string
    • PreparationNotes string
    • Quantity number
    • Unit string

BigOven.Model.API.IngredientInfo

  • BigOven.Model.API.IngredientInfo object
    • Department string
    • MasterIngredientID integer
    • Name string
    • UsuallyOnHand boolean

BigOven.Model.API.NutritionInfo

  • BigOven.Model.API.NutritionInfo object
    • CaloriesFromFat number
    • Cholesterol number
    • CholesterolPct number
    • DietaryFiber number
    • DietaryFiberPct number
    • MonoFat number
    • PolyFat number
    • Potassium number
    • PotassiumPct number
    • Protein number
    • ProteinPct number
    • SatFat number
    • SatFatPct number
    • SingularYieldUnit string
    • Sodium number
    • SodiumPct number
    • Sugar number
    • TotalCalories number
    • TotalCarbs number
    • TotalCarbsPct number
    • TotalFat number
    • TotalFatPct number
    • TransFat number

BigOven.Model.API.Recipe

  • BigOven.Model.API.Recipe object
    • ActiveMinutes integer
    • AdTags string
    • AdminBoost integer
    • AllCategoriesText string
    • BookmarkImageURL string
    • BookmarkSiteLogo string
    • BookmarkURL string
    • Category string
    • Collection string
    • CollectionID integer
    • CreationDate string
    • Cuisine string
    • Description string
    • FavoriteCount integer
    • HeroPhotoUrl string
    • ImageSquares array
      • items integer
    • ImageURL string
    • Ingredients array
    • IngredientsTextBlock string
    • Instructions string
    • IsBookmark boolean
    • IsPrivate boolean
    • IsRecipeScan boolean
    • IsSponsored boolean
    • LastModified string
    • MaxImageSquare integer
    • MedalCount integer
    • MenuCount integer
    • Microcategory string
    • NotesCount integer
    • NutritionInfo BigOven.Model.API.NutritionInfo
    • Poster BigOven.Model.API.UserInfo
    • PrimaryIngredient string
    • RecipeID integer
    • ReviewCount integer
    • StarRating number
    • Subcategory string
    • Title string
    • TotalMinutes integer
    • VariantOfRecipeID integer
    • VerifiedByClass string
    • VerifiedDateTime string
    • WebURL string
    • YieldNumber number
    • YieldUnit string

BigOven.Model.API.RecipeInfo

  • BigOven.Model.API.RecipeInfo object
    • BookmarkURL string
    • Category string
    • CreationDate string
    • Cuisine string
    • HeroPhotoUrl string
    • HideFromPublicSearch boolean
    • ImageURL string
    • ImageURL120 string
    • IsBookmark boolean
    • IsPrivate boolean
    • MaxImageSquare integer
    • Microcategory string
    • Poster BigOven.Model.API.UserInfo
    • QualityScore number
    • RecipeID integer
    • ReviewCount integer
    • StarRating number
    • StarRatingIMG string
    • Subcategory string
    • Title string
    • TotalTries integer
    • WebURL string
    • YieldNumber number

BigOven.Model.API.RecipeNote

  • BigOven.Model.API.RecipeNote object
    • CreationDate string
    • Date string
    • DateDT string
    • GUID string
    • ID integer
    • Notes string
    • People string
    • RecipeID integer
    • UserID integer
    • Variations string

BigOven.Model.API.RecipeNoteList

BigOven.Model.API.Reply

BigOven.Model.API.Review

BigOven.Model.API.UserInfo

  • BigOven.Model.API.UserInfo object
    • FirstName string
    • ImageURL48 string
    • IsKitchenHelper boolean
    • IsPremium boolean
    • IsUsingRecurly boolean
    • LastName string
    • MemberSince string
    • PhotoUrl string
    • PremiumExpiryDate string
    • UserID integer
    • UserName string

BigOven.Model.API.UserInfoTiny

  • BigOven.Model.API.UserInfoTiny object
    • FirstName string
    • LastName string
    • PhotoUrl string
    • UserID integer
    • UserName string

BigOven.Model.API2.CollectionInfo

  • BigOven.Model.API2.CollectionInfo object
    • Description string
    • ID integer
    • IsFiltered boolean
    • IsSponsored boolean
    • MobileUrl string
    • PRO boolean
    • PhotoUrl string
    • Results array
    • Title string
    • Token string
    • WebUrl string

BigOven.Model.API2.GroceryList

BigOven.Model.API2.Photo

  • BigOven.Model.API2.Photo object

BigOven.Model.API2.Recipe

  • BigOven.Model.API2.Recipe object
    • ActiveMinutes integer
    • AdTags string
    • AdminBoost integer
    • AllCategoriesText string
    • BookmarkImageURL string
    • BookmarkSiteLogo string
    • BookmarkURL string
    • Category string
    • Collection string
    • CollectionID integer
    • CreationDate string
    • Cuisine string
    • Description string
    • FavoriteCount integer
    • ImageSquares array
      • items integer
    • ImageURL string
    • Ingredients array
    • IngredientsTextBlock string
    • Instructions string
    • IsBookmark boolean
    • IsPrivate boolean
    • IsRecipeScan boolean
    • IsSponsored boolean
    • LastModified string
    • MaxImageSquare integer
    • MedalCount integer
    • MenuCount integer
    • Microcategory string
    • NotesCount integer
    • NutritionInfo BigOven.Model.API.NutritionInfo
    • PhotoUrl string
    • Poster BigOven.Model.API.UserInfo
    • PrimaryIngredient string
    • RecipeID integer
    • ReviewCount integer
    • StarRating number
    • Steps array
    • Subcategory string
    • Title string
    • TotalMinutes integer
    • VariantOfRecipeID integer
    • VerifiedByClass string
    • VerifiedDateTime string
    • WebURL string
    • YieldNumber number
    • YieldUnit string

BigOven.Model.API2.RecipeInfox

  • BigOven.Model.API2.RecipeInfox object
    • Category string
    • CreationDate string
    • Cuisine string
    • IsBookmark boolean
    • IsPrivate boolean
    • IsRecipeScan boolean
    • Microcategory string
    • PhotoUrl string
    • Poster BigOven.Model.API2.UserInfoTinyx
    • RecipeID integer
    • ReviewCount integer
    • Servings number
    • StarRating number
    • Subcategory string
    • Title string
    • TotalTries integer
    • WebURL string

BigOven.Model.API2.RecipeNote

  • BigOven.Model.API2.RecipeNote object
    • CreationDate string
    • Date string
    • DateDT string
    • GUID string
    • ID integer
    • Notes string
    • People string
    • RecipeID integer
    • UserID integer
    • Variations string

BigOven.Model.API2.RecipeSearchResult

BigOven.Model.API2.UserInfoTinyx

  • BigOven.Model.API2.UserInfoTinyx object
    • FirstName string
    • LastName string
    • PhotoUrl string
    • UserID integer
    • UserName string

BigOven.Model.Article

  • BigOven.Model.Article object
    • AllCategoriesText string
    • ApprovedForDisplay boolean
    • ArticleId integer
    • AssignedToUserID integer
    • Body string
    • Byline string
    • CaptionedImages array
    • CategoryID integer
    • DateApproved string
    • DateAssigned string
    • DateCreated string
    • DeadlineDate string
    • Id string
    • InternalAbstract string
    • IsSeasonal boolean
    • LineOrder integer
    • PrimaryImage string
    • ReadyForReview boolean
    • SeasonalEndEmphasis string
    • SeasonalStartEmphasis string
    • ShortURL string
    • Slug string
    • SubcategoryID integer
    • Subhead string
    • Title string
    • keywordUnique string

BigOven.Model.CaptionedImage

  • BigOven.Model.CaptionedImage object
    • Caption string
    • PhotoUrl string

BigOven.Model.InstructionStep

  • BigOven.Model.InstructionStep object
    • EndGantt integer
    • StartGantt integer
    • Text string

BigOven.Model.RecipeCategory

  • BigOven.Model.RecipeCategory object
    • Category string
    • DefaultActiveMinutes integer
    • DefaultTotalMinutes integer
    • ID integer
    • ParentID integer
    • PrimaryImage string
    • ShortDescription string

BigOven.Model.RecipeInfoDateTuple2

BigOven.Model.RecipeInfoReviewTuple2

BigOven.Model.RecipeInfoTiny

  • BigOven.Model.RecipeInfoTiny object
    • ImageURL string
    • QualityScore integer
    • RecipeID integer
    • Servings number
    • Title string

BigOven.Model.ShoppingListLine

  • BigOven.Model.ShoppingListLine object
    • DateAdded string
    • Dept string
    • GUID string
    • HTMLItemName string
    • IsChecked boolean
    • ItemName string
    • LastModified string
    • ListID integer
    • MealPlanID integer
    • MealPlanObjectType integer
    • Notes string
    • PendingAddition boolean
    • RecipeID integer
    • ShoppingListLineID integer
    • Store string
    • TextAmt string
    • ThirdPartyHost string
    • ThirdPartyTitle string
    • ThirdPartyURL string

System.Object

  • System.Object object

System.Text.DecoderFallback

  • System.Text.DecoderFallback object
    • MaxCharCount integer

System.Text.EncoderFallback

  • System.Text.EncoderFallback object
    • MaxCharCount integer

System.Text.Encoding

  • System.Text.Encoding object
    • BodyName string
    • CodePage integer
    • DecoderFallback System.Text.DecoderFallback
    • EncoderFallback System.Text.EncoderFallback
    • EncodingName string
    • HeaderName string
    • IsBrowserDisplay boolean
    • IsBrowserSave boolean
    • IsMailNewsDisplay boolean
    • IsMailNewsSave boolean
    • IsReadOnly boolean
    • IsSingleByte boolean
    • WebName string
    • WindowsCodePage integer

System.Web.Mvc.JsonResult

  • System.Web.Mvc.JsonResult object
datafire
@infinitebrahmanuniverse/nolb-_datafire_b@everything-registry/sub-chunk-221
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago

0.0.3

9 years ago

0.0.1

9 years ago