Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

This API call will return a detailed basket results, both as an aggregate and detailed data. Meaning you check and verify the choices a respondent has given.

New server Endpoint (note this is different to get params_id):

https://public-survey-data-api.rose.conceptsauce.io/api

Request body:

{
	"event_type": "survey_data_request",
	"action": "get_shop_shelf_detail_purchases",
	"data": {
		"target": {
			"survey_id": "SURV01FYE81P9SN5N66XG9YFCEVSQ9",
			"block_id": "shelf",
			"respondent_encoded": "enc14367fa406b368698d7dfa3034bda0d005b10eea"
		}
	}
}

Response:

{
	"reason": null,
	"code": 200,
	"data": {
		"survey_id": "SURV01FYE81P9SN5N66XG9YFCEVSQ9",
		"block_id": "shelf",
		"respondent_id": "null",
		"respondent_encoded": "enc14367fa406b368698d7dfa3034bda0d005b10eea",
		"basket_details": {
			"aggregated_purchase_details": {
				"9310055790919": {
					"sku": "9310055790919",
					"quantity": 1,
					"price_for_one": 5.99
				}
			},
			"raw_purchase_details": [
				{
					"sku": "9310055790919",
					"quantity": 1,
					"price_for_one": 5.99,
					"bay_id": "1",
					"zone": "Default_zone",
					"time": 1647849800007.0,
					"relative_time": 8410.0
				}
			]
		}
	},
	"event_type": "survey_data_request",
	"action": "get_shop_shelf_detail_purchases",
	"client_msg_id": ""
}

respondent_encoded is the one passed in the respondent App url as respondent_id and is retrieved using the Get Respondent Encoded ID step.

block_id is the same as present in Admin App

relative_time as currently "duration between block start to time of purchase" 

Inside the target , each parameter must be set manually. The provided by survey_id, respondent_id and block_id ARE ONLY EXAMPLES.

If the specified value is invalid, response for such a request will be with code: 802 (which means: No data available for specified target)

The response with 802 code may also mean: The target is alright, but no respondent bought anything yet.

  • No labels