Vastuse üldkuju

Miratag abikeskkond APIAPI kirjeldusVastuse üldkuju

Vastus koosneb ühest või mitmest osast. Päringu edukust ja iseloomu määrab jada „head“, mis sisaldab järgnevaid muutujaid.

Nimetus

Kirjeldus

status

ok = päring oli edukas
error = päring ebaõnnestus

error_code

Vea kood, kui päring ebaõnnestus

items_total

Kirjete arv kokku kui päring väljastas enam kui ühe kirje

items_in_responce

Tagastatud kirjete arve antud päringus

Päringu tulemus edastatakse muutujas „data“.

Näide (tagastatakse info ühe elemendi kohta)

{
                "head":{
                                "status":"ok",
                                "error_code":""
                },
                "data":{
                                "variable":"value"
                }
}

Näide (tagastatakse nimekiri elementidest)

{
                "head":{
                                "status":"ok",
                                "error_code":"",
                                "items_total":20,
                                "items_in_responce":2
                },
                "data":[
                                {
                                                "variable 1":"abc",
                                                "variable 2":123
                                },
                                {
                                                "variable 1":"def",
                                                "variable 2":456
                                }
                ]
}

Näide (veateade)

{
                "head":{
                                "status":"error",
                                "error_code":"101"
                }
}

Kas sellest juhendist oli abi? Jah Ei