Version 1 - Time Series Codebook
Released At: 29 Apr 2015Last Updated At: 02 Nov 2015
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/v1/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 |
---|---|
code | Code of the question. Youwill use this valueto run an analysis. |
original_code | The original code from the datasource. The difference between the code and original_code is that the code is lower case and has '.' replaced with '|'. |
text | The question text |
notes | Any special notes about the question |
answers |
An array of the possible answers with the following values:
|
Examples
Here is an example of what can be returned after calling this method with the following url:
http://data.unicef.ge/en/api/v1/time_series_codebook?access_token=123456789&time_series_id=1111111111
{ questions: [ { code: "gender", original_code: "GENDER", text: "What is your gender?", 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 } ] }, { 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 } ] } ] }