सभी उत्तरों में एक आवेदन / जेएसएन सामग्री प्रकार है और आम तौर पर स्वीकृत स्थिति कोडों का पालन करें:

स्थिति विवरण
200 ठीक
401 गलत एपीआई कुंजी
403 प्रवेश निषेध
404 नहीं मिला
405 विधि की अनुमति नहीं है
422 असंसाधित इकाई
500 आंतरिक सर्वर त्रुटि

सफल प्रतिक्रिया आधार-सामग्री हमेशा आधार-सामग्री कुंजी में होता है, उदाहरण के लिए:

{
    "data": {
        "id": 123,
        "name": "Example",
        "active": true
    }
}

प्रति पृष्ठ पर आधार-सामग्री सरणियों को वापस किया जा सकता है:

{
    "data": [],
    "links": {
        "first": "https://simex.global/api/example?page=1",
        "last": "https://simex.global/api/example?page=5",
        "prev": "https://simex.global/api/example?page=2",
        "next": "https://simex.global/api/example?page=4"
    },
    "meta": {
        "current_page": 3,
        "from": 31,
        "last_page": 5,
        "path": "https://simex.global/api/example",
        "per_page": 15,
        "to": 45,
        "total": 75
    }
}

कोड 4 के साथ एक त्रुटि के मामले में * संदेश कुंजी संदेश में रखा गया है, उदाहरण के लिए:

{
    "message": "Unauthenticated."
}

422 कोड के साथ उदाहरण प्रतिक्रिया - अमान्य अनुरोध:

{
    "message": "The given data was invalid.",
    "errors": {
        "pair": [
            "The pair field is required."
        ]
    }
}

वापस अगला