Method List


Beef Cut Methods

Method Name Functionality
public BeefAPIIngredientList GetAllBeefCuts() Returns a list of all beef cuts that are available via the API.1
public Ingredient GetBeefCutById(int id) Returns a single beef cut by beef cut Id
public Ingredient GetBeefCutByName(string name) Returns a single beef cut by beef cut slug name
public BeefAPIIngredientTreeListing GetBeefCutTree(int id) For a given beef cut, this call will return all the ancestors that are available for the cut and will return all the descendants of the given cut using deep recursion including all the leaves of the tree until there are no more available. This call returns the media for any cut that is online.
public BeefAPIIngredientSummaryListing GetBeefCutPrimals() Calls to this endpoint will return a summary list of the beef cuts representing all the primal cuts found in the API.
public BeefAPIIngredientSummaryListing GetBeefCutList(List idList) Returns a summary list of beef cuts based on a given list of beef cut ingredient IDs.
public BeefAPICollectionList GetAllBeefCutCollections() Return a list of all the beef cut collections that are available via the API.
public BeefAPICollectionList GetBeefCutCollectionById(int id) Returns all the information about a single beef cut collection by collection Id.
public BeefAPICollectionList GetBeefCutCollectionByName(string name) Returns all the information about a single beef cut collection by beef cut slug name.
public BeefAPICollectionList GetBeefCutCollectionsByList(List idList) Return a summary list of the beef cut collections based on a given list of collection IDs.
public BeefAPIIngredientRecipeListing GetBeefCutRecipes(int id) Returns a list of recipes that are used by a given beef cut. If the beef cut is part of a group of similar beef cuts, recipes will also be returned for each beef cut in each group that the given beef cut belongs to.
public IngredientSearchResultModel SearchBeefCut(IngredientSearch ingredientSearch) Returns a list of the beef cut summary objects.
public CollectionSearchResultModel SearchBeefCutCollection(IngredientCollectionSearch ingredientCollectionSearch) Return a list of the beef cut collection summary objects.


Recipe Methods

Method Name Functionality
public BeefAPIRecipeList GetAllRecipes() Return a list of all the recipes that are available via the API.
public Recipe GetRecipeById(int id) Returns a single recipe by recipe Id.
public Recipe GetRecipeByName(string name) Returns a single recipe by recipe slug name.
public BeefAPIRecipeSummaryListing GetRecipeList(List idList) Returns a summary list of recipes based on a given list of recipe IDs.
public BeefAPICollectionList GetAllRecipeCollections() Returns a list of all the recipe collections that are available via the API.
public CollectionSummaryWithRecipes GetRecipeCollectionById(int id) Returns all the information about a single recipe collection by recipe collection Id.
public CollectionSummaryWithRecipes GetRecipeCollectionByName(string name) Returns all the information about a single recipe collection by recipe collection slug name.
public BeefAPICollectionSummaryListing GetRecipeCollectionsByList(List idList) Returns a summary list of the recipe collections based on a given list of collection IDs.
public RecipeSearchResultModel SearchRecipe(RecipeSearch recipeSearch) Returns a list of the recipe summary objects.
public RecipeSearchResultModel SearchRecipeCollection(RecipeSearch recipeSearch) Returns a list of the recipe summary objects.
public BeefAPIRecipeCollectionList SearchRecipeCollectionGroup(RecipeSearch recipeSearch) Return a list of the recipe collection summary objects.

Common

public CommonLookup GetCommonLookups()

For the Recipe, BeefCut, and Collection search API endpoints, there are acceptable values used for the search parameters that represent specific values used to search for an item. Use the helper call above to identify the acceptable search parameter key-value pairs that can be passed to the search endpoints. The general data structure of each lookup object will have a *Name and a *NameSlug property. The search endpoint parameter searches accept the "NameSlug" properties and will be an exact match on those values. If you call the search API endpoint with a value that is not found in the common lookup models, unexpected results may be returned.


These same model values will also be returned as part of the larger objects when they are called. For example, when calling a the "Get single recipe by ID" endpoint, part of that object returned will be an array of attributes. This data structure matches the common/lookups attributes model but will only return the attributes by type that are marked specifically for that ingredient. The same consistency is also true with other properties and sub properties of recipe allergens, collections, recipeType etc.