API για τα ανοιχτά δεδομένα

Stavros Papadakis edited this page Nov 18, 2016 · 3 revisions

Τα ανοικτά δεδομένα που είναι καταχωρημένα στο σύστημα Edulabs είναι διαθέσιμα και μέσω API σε μορφη JSON.

Η αναλυτική τεκμηρίωση των παρεχόμενων λειτουργιών καθώς και δοκιμαστικό περιβάλλον είναι διαθέσιμα στη διεύθυνση τεκμηρίωσης. Η τεκμηρίωση είναι βασισμένη στο πρότυπο Swagger (έκδοση 2).

Γενική περιγραφή

Στοιχεία σελιδοποίησης

Τα δεδομένα παρέχονται σε μορφή JSON και είναι στην πλειονότητα τους σελιδοποιημένα. Το πλήθος αποτελεσμάτων ανά σελίδα είναι παραμετροποιήσιμο, με μέγιστο πλήθος αποτελεσμάτων 200. Τα δεδομένα περιλαμβάνουν τις παρακάτω ιδιότητες που ο προγραμματιστής μπορεί να εκμεταλλευτεί για να πλοηγηθεί στο σύνολο των αποτελεσμάτων:

  • count: πλήθος αποτελεσμάτων στα επιστρεφόμενα αποτελέσματα
  • countall: συνολικό πλήθος αποτελεσμάτων που ικανοποιούν τα κριτήρια
  • page: τρέχων αριθμός "σελίδας" αποτελεσμάτων
  • pages: συνολικός αριθμός σελίδων

Παράδειγμα:

{
    "count": 20,
    "countall": 7418,
    "page": 1,
    "pages": 371,
}

Κατάσταση αιτήματος

Τα δεδομένα περιλαμβάνουν τα παρακάτω πεδία για τον προσδιορισμό της κατάστασης του αιτήματος. Σε περίπτωση που δεν επιστραφούν καθόλου δεδομένα, θα πρέπει να εξεταστεί το http status code του response.

  • status: το http status code της απάντησης, για παράδειγμα 200, 404, 400
  • success: ένδειξη επιτυχούς απάντησης

Παράδειγμα:

{
    "status": 200,
    "success": true,
}

Αιτούμενα στοιχεία

Τα δεδομένα περιλαμβάνουν δύο πεδία για τον προσδιορισμό των επιστρεφόμενων στοιχείων και κατάλληλων ετικετών τους.

  • labels: ετικέτες των πεδίων των επιστρεφόμενων στοιχείων
  • data: τα επιστρεφόμενα στοιχεία

Παράδειγμα:

    "labels": {
        "registry_no": "Κωδικός μονάδας",
        "school_name": "Ονομασία",
        "school_type": "Τύπος μονάδας",
        "prefecture": "Περιφερειακή ενότητα",
        "municipality": "Δήμος",
        "eduadmin": "Διεύθυνση εκπαίδευσης",
        "region_edu_admin": "Περιφερειακή διεύθυνση εκπαίδευσης",
        "education_level": "Βαθμίδα εκπαίδευσης"
    },
    "data": [
        {
            "registry_no": "1765010",
            "school_name": "ΗΜΕΡΗΣΙΟ ΓΕΝΙΚΟ ΛΥΚΕΙΟ ΑΣΗΜΙΟΥ ΗΡΑΚΛΕΙΟΥ",
            "school_type": "ΓΕΝΙΚΟ ΛΥΚΕΙΟ",
            "prefecture": "ΗΡΑΚΛΕΙΟΥ",
            "municipality": "ΓΟΡΤΥΝΑΣ",
            "eduadmin": "ΔΙΕΥΘΥΝΣΗ Δ.Ε. ΗΡΑΚΛΕΙΟΥ",
            "region_edu_admin": "ΠΕΡΙΦΕΡΕΙΑΚΗ ΔΙΕΥΘΥΝΣΗ ΚΡΗΤΗΣ",
            "education_level": "ΔΕΥΤΕΡΟΒΑΘΜΙΑ"
        },
        {
            "registry_no": "3202010",
            "school_name": "1ο ΗΜΕΡΗΣΙΟ ΓΥΜΝΑΣΙΟ ΙΕΡΑΠΕΤΡΑΣ ΛΑΣΙΘΙΟΥ",
            "school_type": "ΓΥΜΝΑΣΙΟ",
            "prefecture": "ΛΑΣΙΘΙΟΥ",
            "municipality": "ΙΕΡΑΠΕΤΡΑΣ",
            "eduadmin": "ΔΙΕΥΘΥΝΣΗ Δ.Ε. ΛΑΣΙΘΙΟΥ",
            "region_edu_admin": "ΠΕΡΙΦΕΡΕΙΑΚΗ ΔΙΕΥΘΥΝΣΗ ΚΡΗΤΗΣ",
            "education_level": "ΔΕΥΤΕΡΟΒΑΘΜΙΑ"
        }
    ]

Αναλυτικές λεπτομέρειες παρέχονται στη σελίδα τεκμηρίωσης.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.