Version 2 (groups & weights) - მონაცემთა კოდები

გამოქვეყნებულია: 25 იანვ 2016ბოლო განახლება: 26 იანვ 2016

მონაცემთა კოდების მიღება 

URL

ამ მეთოდის გამოძახებისთვის გამოიყენეთ HTTP GET მოთხოვნა შემდეგი URL-სთვის:

http://data.unicef.ge/[locale]/api/v2/dataset_codebook

სადაც:

  • [locale] = ენა, რომელშიც გსურთ მონაცემების მიღება (ამ დროისთვის ka ქართულად ან en ინგლისურად)

აუილებელი პარამეტრები

მოთხოვნა უნდა შეიცავდეს შემდეგ პარამეტრებს:

პარამეტრიაღწერა
access_token ყველა მოთხოვნა უნდა შეიცავდეს დაშვების გასაღებს. თქვენ მარტივად და უფასოდ შეგიძლიათ მიიღოთ დაშვების გასაღები აქ გადასვლით.
dataset_id მონაცემების ID

 

არჩევით პარამეტრები

მოთხოვნისთვის შემდეგი პარამეტრები არის არჩევითი.

პარამეტრიაღწერა
language

კოდი ენისთვის, რომელშიც დაბრუნდება მონაცემებზე ინფორმაცია (მაგ. en ინგლისური ენისთვის). იმ შემთხვევაში, თუ language არ არის მოცემული, ცხრილისთვის გამოყენებული იქნება ძირითადი ენა.

რას მიიღებთ

დაბრუნებული ობიექტი იქნება მონაცემთა კითხვებითა და პასუხებით შემდგარი JSON მასივი შემდეგი ინფორმაციით:

პარამეტრიაღწერა
id მონაცემების უნიკალური ID
url URL to the dataset
title მონაცემების სახელწოდება
description მონაცემთა აღწერა შეიძლება შეიცავდეს html-ის კოდს
source იმ წყაროს დასახელება, რომელმაც შეაგროვა მონაცემები
weights

An array of weights with the following information:

  • name - the name of the weight
  • is_default - a boolean flag indicating if this is the default weight for the dataset
  • applies_to_all - a boolean flag indicating if the weight applies to all questions in the dataset
  • codes - if applies_to_all is false, then this contains a list of all question codes that the weight applies to
items

An array of groups and questions. Groups have the following information:

  • title - the title of the group
  • description - a description of the group
  • items - an array of questions and groups that are in this group

Questions have the following information:

  • code - კითხვის კოდი. თქვენ გამოიყენებთ ამ მნიშვნელობას  ანალიზის გასაკეთებლად
  • original_code - code of the question; you will use this value to run an analysis
  • text - კითხვის ტექსტი
  • notes - შენიშვნები კითხვასთან დაკავშირებით
  • is_mappable - ულის ალამი, რომელიც მიუითითებს არის თუ არა ეს კითხკვა დაკავშირებული რუკის ფორმებთან
  • answers - სავარაუდო პასუხების მასივი შემდეგი  მნიშვნელობებით:
    • value - პასუხის მნიშვნელობა
    • text - პასუხის ტექსტი
    • can_exclude - ბულის ალამი, რომელიც მიუითითებს, რომ შესაძლოა ანალიზიდან ამ პასუხის გამოტოვება
    • sort_order - რიგითობა, როგორც დალაგდება პასუხები

მაგალითები

მაგალითისთვის მოცემულია, თუ რა შეიძლება დაბრუნდეს ამ მეთოდის გამოძახების შემდეგ მოცემული url-ის გამოყენებით:

http://data.unicef.ge/en/api/v2/dataset_codebook?access_token=123456789&dataset_id=1111111111
{
  id: "1111111111",
  url: "http://data.unicef.ge/en/datasets/dataset1",
  title: "This is a dataset!",
  description: "This is the description of the dataset.",
  source: "People",
  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
          }
        ]
      }
    }
  ]
}