Version 2 (groups & weights) - Time Series Codebook
Released At: 25 Jan 2016Last Updated At: 26 Jan 2016
Get the codebook for a time series.
URL
To call this method, use an HTTP GET request to the following URL:
http://data.unicef.ge/[locale]/api/v2/time_series_codebook
where:
- [locale] = the locale of the language you want the data to be returned in (currently ka for Georgian or en for English)
Required Parameters
The following parameters must be included in the request:
Parameter | Description |
---|---|
access_token | All requests must include an access_token. You can obtain an access token easily, and for free, by going here. |
time_series_id | The ID of the time series. |
Optional Parameters
There following parameters are optional for this call.
Parameter | Description |
---|---|
language | Code of the language to return the time series information in (e.g., en for English). If language is not provided, the default language of the time series will be used. |
What You Get
The return object is a JSON array of the time series questions and answers with the following information:
Parameter | Description |
---|---|
id | Unique ID of the time series |
url | URL to the time series |
title | The title of the time series |
description | A description of the time series, may include htmlmarkup |
weights |
An array of weights with the following information:
|
items |
An array of groups and questions. Groups have the following information:
Questions have the following information:
|
Examples
Here is an example of what can be returned after calling this method with the following url:
http://data.unicef.ge/en/api/v2/time_series_codebook?access_token=123456789&time_series_id=1111111111
{ id: "1111111111", url: "http://data.unicef.ge/en/time_series/time_series1", title: "This is a time series!", description: "This is an amazing time series!" weights: [ { name: "Individual Weight", is_default: true, applies_to_all: true, codes: [] } ], items: [ { group: { title: "Group 1", description: "This is a description of Group 1", items: [ { question: { code: "gender", original_code: "GENDER", text: "What is your gender?", notes: null, is_mappable: false, answers:[ { value: "1", text: "Male", can_exclude: false, sort_order: 1 }, { value: "2", text: "Female", can_exclude: false, sort_order: 2 }, { value: "3", text: "Refuse to Answer", can_exclude: true, sort_order: 3 } ] } }, { question: { code: "age", original_code: "AGE", text: "What is your age?", is_mappable: false, answers:[ { value: "1", text: "< 18", can_exclude: false, sort_order: 1 }, { value: "2", text: "18-65", can_exclude: false, sort_order: 2 }, { value: "3", text: "> 65", can_exclude: false, sort_order: 3 } ] } } ] } }, { question: { code: "live", original_code: "LIVE", text: "Where do you live?", is_mappable: false, answers:[ { value: "1", text: "Tbilisi", can_exclude: false, sort_order: 1 }, { value: "2", text: "London", can_exclude: false, sort_order: 2 }, { value: "3", text: "New York City", can_exclude: false, sort_order: 3 } ] } } ] }
Version 2 (groups & weights)
- Dataset Catalog
- Dataset Details
- Dataset Codebook
- Dataset Analysis
- Time Series Catalog
- Time Series Details
- Time Series Codebook
- Time Series Analysis