GET / POST Search Recipe Collection

Calls to this endpoint will return a list of the recipe collection summary objects.

This endpoint can be called via GET or POST. Calling the search via POST will check the body of the request for the search criteria:

GET /api/v2/recipe/collection/search
POST /api/v2/recipe/collection/search

What it Returns

Requests to the Search recipe collections will return the following data:

• CollectionSearchResultModel object
  A container that holds the search result information
  • searchResults array
    A list of recipe collections summary objects
    • collectionID int
      Unique identifier of the collection
    • collectionName string
      Name of the collection
    • collectionNameSlug string
      URL-friendly slugged name of the collection
    • collectionGroup object
      Contains information about the group to which the collection belongs. Object values found in this array will be an exact match to what can be found in the master list of collection groups in the common endpoint (/api/v2/common/lookups)
      • collectionGroupName string
        Name of the collection group
      • collectionGroupNameSlug string
        URL-friendly name of the collection group
      • objectType object
        The type object this collection group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
        • objectTypeName string
          The name of the object type this collection group pertains to
        • objectTypeNameSlug string
          URL-friendly slugged name of the object type this collection group pertains to
    • objectType object
      The type object this collection group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
      • objectTypeName string
        The name of the object type this collection group pertains to
      • objectTypeNameSlug string
        URL-friendly slugged name of the object type this collection group pertains to
    • tagline string
      Short, consise description of the collection
    • description string
      Text used to describes the contents and use of the collection
    • estimatedItemCount int
      an estimated count of recipes that are included in this collection
    • media array
      A list of media objects containing information about media assigned to this collection
      • widenURL string
        This is the base part of the URL that is needed to build the embed link
      • widenUID string
        This is the customer userid part of the URL that is needed to build the embed link
      • externalID string
        This is the unique identifier of the media item
      • filename string
        This is the filename of the media item
      • title string
        This is the title of the media item
      • caption string
        This is the caption used for the media item
      • mediaGroup object
        Media will always be returned grouped and sorted. Use this grouping to help manage any groupings that may be suggested from the BeefAPI. Object values found in this array will be an exact match to what can be found in the master list of mediaGroups in the common endpoint (/api/v2/common/lookups)
        • mediaGroupName string
          Name of the media group
        • mediaGroupNameSlug string
          URL-friendly slugged name of the media group
        • objectType object
          The type object this media group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
          • objectTypeName string
            The name of the object type
          • objectTypeNameSlug string
            URL-friendly name of the object type
        • mediaType string
          The type of media returned
        • sortOrder int
          The suggested sort order to be used for this media item
        • links array
          A list HATEOAS for this media item that is a link to view the media in its original size
          • rel string
            The rel attribute specifies the relationship between the current document and the linked document
          • href string
            URI of the beefapi call to get more information for this links' context
          • title string
            Title of the link
    • links array
      A list of HATEOAS in relation to this collection. Typically if this collection is online, you will be provided with a link to the endpoint to get the full collection details.
      • rel string
        The rel attribute specifies the relationship between the current document and the linked document
      • href string
        URI of the beefapi call to get more information for this links' context
      • title string
        Title of the link
  • searchCriteria object
    An object representing the search parameters that were passed into the search recipes API call.
    • searchText string
      The search will look for this text anywhere in the recipe collection model.
    • collectionGroups array
      A list of collection Groups that the recipe collection may contain. Values in this array must be an exact match to the common/lookups CollectionGroups model where the collectionGroup.ObjectType.ObjectTypeNameSlug ='recipe'. Any values that are not an exact match to this field may return unexpected results.
    • pageNumber int
      Used in conjunction with the itemsPerPage parameter to manage paging in a search. This will default to page 1 if no value is provided.
    • itemsPerPage int
      Used in conjunction with the pageNumber parameter to manage paging in a search. This will default to 10 if no value is provided. The maximum items per page is 50.
  • totalCount int
    Estimated total count of items that match the search criteria
  • curPage int
    The current page of the search results
  • itemsPerPage object
    The current items per page used in returning the search results
  • links array
    A list of HATEOAS in relation to this search call.
    • rel string
      The rel attribute specifies the relationship between the current document and the linked document
    • href string
      URI of the beefapi call to get more information for this links' context
    • title string
      Title of the link