Skip to main content

Source

A survey wave of a SOURCES axis. An unknown field, here or in weight, returns 400 AE_ERR_411. selected, weeks and weight are returned only when they have a value.

idstring

Code of the survey wave, as returned in code by GET /api/v2/users/surveys.

labelstring

Display label of the survey wave, in the language of the user. Ignored in requests.

selectedboolean

Wave shown when the SOURCES axis is in PLANES: at most one wave of that axis can be selected (more return 400 AE_ERR_404), and without any the first one is shown. In ROWS or COLUMNS every wave is calculated and shown.

weeksstring[]

Weeks of the wave, each with the id (YYYY/WW) returned by GET /api/v2/survey/{surveyCode}/weeks-and-weights for this survey. A wave of a survey with weeks that comes without them, or with a week the survey does not have, is left out with a TR_ERR_107 diagnostic. Ignored for a survey without weeks. An empty list is the same as not sending it.

weight object

A weighting of a survey, as returned by GET /api/v2/survey/{surveyCode}/weeks-and-weights and in the weights of each survey of GET /api/v2/users/surveys. It can be sent as it is returned: only id is read, and it is required (400 AE_ERR_412 without it); label, universe and isDefault are ignored.

idstringrequired

Identifier of the weighting.

labelstring

Name of the weighting, as the survey defines it. It is not translated.

universeinteger<int32>

Universe of the weighting. It can be missing.

isDefaultboolean

Whether it is the default weighting of the survey, the one used when a table is sent without a weighting.

Source
{
"id": "string",
"label": "string",
"selected": true,
"weeks": [
"string"
],
"weight": {
"id": "string",
"label": "string",
"universe": 0,
"isDefault": true
}
}