GET /routines/:id/detailed_summary

GET /routines/{id}/detailed_summary.yml

Returns detailed summary of routine

Path parameters

id integer(int64) Required

ID of the resource to fetch

Responses

200

successful operation
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes array[object]
  
  routine_step_id integer
  
  ingredients array[object]
  
  Hide ingredients attributes Show ingredients attributes array[object]
  
  has_opinion boolean
  
  explanation string
  
  ingredient object
  
  Hide ingredient attributes Show ingredient attributes object
  
  id integer
  
  title string
  
  alias string
  
  product object
  
  Hide product attributes Show product attributes object
  
  id integer(int32)
  
  title string
  
  full_title string
  
  alias string
  
  owner_user_id integer(int32)
  
  brand_id integer(int32)
  
  category_id integer(int32)
  
  product_image object
  
  Hide product_image attributes Show product_image attributes object
  
  id integer
  
  product_id integer
  
  product_draft_id integer
  
  image string
  
  url string
  
  brand object
  
  Hide brand attributes Show brand attributes object
  
  id integer
  
  alias string
  
  title string
  
  product_category object
  
  Hide product_category attributes Show product_category attributes object
  
  id integer(int32)
  
  title string
  
  alias string
  
  owner_user object
  
  Hide owner_user attributes Show owner_user attributes object
  
  id integer
  
  username string
  
  user_type string
  
  last_active string
  
  product_pitch object
  
  Hide product_pitch attributes Show product_pitch attributes object
  
  id integer(int32)
  
  affiliate_url string
  
  coupon_code string
  
  product_tutorial object
  
  Hide product_tutorial attributes Show product_tutorial attributes object
  
  id integer
  
  product_id integer
  
  user_id integer
  
  general_info string
  
  unit_of_measurement_display string
  
  measurement_value string
  
  product_tutorial_instructions array[object]
  
  Hide product_tutorial_instructions attribute Show product_tutorial_instructions attribute array[object]
  
  instruction string
  
  product_tutorial_warnings array[object]
  
  Hide product_tutorial_warnings attribute Show product_tutorial_warnings attribute array[object]
  
  warning string
400

Bad Request
401

Authorization information is missing or invalid.
404

Requested resource not found
500

Server Error

GET /routines/{id}/detailed_summary.yml

curl \
 -X GET https://api.cosmily.com/api/v1/routines/{id}/detailed_summary.yml \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "routine_step_id": 42,
      "ingredients": [
        {
          "has_opinion": true,
          "explanation": "string",
          "ingredient": {
            "id": 42,
            "title": "string",
            "alias": "string"
          }
        }
      ],
      "product": {
        "id": 42,
        "title": "string",
        "full_title": "string",
        "alias": "string",
        "owner_user_id": 42,
        "brand_id": 42,
        "category_id": 42,
        "product_image": {
          "id": 42,
          "product_id": 42,
          "product_draft_id": 42,
          "image": "string",
          "url": "string"
        },
        "brand": {
          "id": 42,
          "alias": "string",
          "title": "string"
        },
        "product_category": {
          "id": 42,
          "title": "string",
          "alias": "string"
        },
        "owner_user": {
          "id": 42,
          "username": "string",
          "user_type": "string",
          "last_active": "string"
        }
      },
      "product_pitch": {
        "id": 42,
        "affiliate_url": "string",
        "coupon_code": "string"
      },
      "product_tutorial": {
        "id": 42,
        "product_id": 42,
        "user_id": 42,
        "general_info": "string",
        "unit_of_measurement_display": "string",
        "measurement_value": "string",
        "product_tutorial_instructions": [
          {
            "instruction": "string"
          }
        ],
        "product_tutorial_warnings": [
          {
            "warning": "string"
          }
        ]
      }
    }
  ]
}

Response examples (200)

{
  "data": [
    {
      "routine_step_id": 42,
      "ingredients": [
        {
          "has_opinion": true,
          "explanation": "string",
          "ingredient": {
            "id": 42,
            "title": "string",
            "alias": "string"
          }
        }
      ],
      "product": {
        "id": 42,
        "title": "string",
        "full_title": "string",
        "alias": "string",
        "owner_user_id": 42,
        "brand_id": 42,
        "category_id": 42,
        "product_image": {
          "id": 42,
          "product_id": 42,
          "product_draft_id": 42,
          "image": "string",
          "url": "string"
        },
        "brand": {
          "id": 42,
          "alias": "string",
          "title": "string"
        },
        "product_category": {
          "id": 42,
          "title": "string",
          "alias": "string"
        },
        "owner_user": {
          "id": 42,
          "username": "string",
          "user_type": "string",
          "last_active": "string"
        }
      },
      "product_pitch": {
        "id": 42,
        "affiliate_url": "string",
        "coupon_code": "string"
      },
      "product_tutorial": {
        "id": 42,
        "product_id": 42,
        "user_id": 42,
        "general_info": "string",
        "unit_of_measurement_display": "string",
        "measurement_value": "string",
        "product_tutorial_instructions": [
          {
            "instruction": "string"
          }
        ],
        "product_tutorial_warnings": [
          {
            "warning": "string"
          }
        ]
      }
    }
  ]
}