Structure

Setiap response dari API menggunakan HTTP Status Code sebagai tanda bahwa request tersebut berhasil atau error.

Status	Description
100-199	Informational Response
200-299	Success Response
300-399	Redirection Message
400-499	Client Error Respons
500-599	Server Error Response

Reference : https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status

Success

Example

{
    "message" : "Berhasil menampilkan data user", //opsional
    "data"  : [
        {
            "id" : 1,
            "nama" : "Helmi Yachya"
        },
        {
            "id" : 2,
            "nama" : "Reza Ahmad"
        }
    ]
}

Success With Pagination

Example

{
    "message" : "Berhasil menampilkan data user", //opsional
    "data"  : [
        {
            "id" : 1,
            "nama" : "Helmi Yachya"
        },
        {
            "id" : 2,
            "nama" : "Reza Ahmad"
        },
        {....}
    ],
    "meta" : {
        "page" : 1,
        "limit" : 10,
        "total_item" : 35,
        "total_page" : 4,
    }
}

Error

Example

{
    "error" : {
        "code" : "INACTIVE_USER",
        "message" : "User anda sudah tidak aktif"
    }
}

Data Parent & Child

Penggunaan data parent atau head data pisahkan dari pengelompokan data item array, sebagai contoh :

Example

{
  "data": [
    {
      "id": 60,
      "event_id": 54,
      "action": "Check",
      "sequence": 1,
      "code": "LFE4HC",
      "notes": "haloo",
      "summary": {
        "total_manifest": 8,
        "total_scanned": 8,
        "total_not_scanned": 0
      }
    },
    {
      "id": 61,
      "event_id": 54,
      "action": "Oke",
      "sequence": 2,
      "code": "DZMK7M",
      "notes": "",
      "summary": {
        "total_manifest": 8,
        "total_scanned": 7,
        "total_not_scanned": 1
      }
    }
  ],
  "event": {
    "id": 54,
    "name": "Joan Gamper",
    "title": "FCB",
    "code_event": "WaSCCIWO",
    "status": "Running",
    "client" : {
      "name": "FC Barcelona"
    },
    "is_deleted": 0
  }
}

Penggunaan data head pada data child harus menggunakan object dari data parent tersebut, sebagai contoh data client yang muncul pada data event :

Example

{
  "id": 1,
  "name": "MADATUKAR",
  "title": "MADATUKAR 2026",
  "code_event": "MDTKR26",
  "status": "Running",
  "client" : {
    "id" : 1,
    "name": "Politeknik Pelayaran Surabaya"
  }
}

Tidak semua data parent client harus ditampilkan, hanya tampil sesuai dengan fungsi nya saja. Maka dari itu response dari API harus bisa menyesuaikan data yang keluar dengan endpoint yang digunakan. Sebagai contoh data client di atas digunakan pada data event dengan hanya membutuhkan id dan name, sedangkan pada data user data client dibutuhkan adalah id, name, phone_number, email.

Example

{
  "id": 1,
  "name": "Yogi Wirmanda",
  "email": "wirmanda@gmail.com",
  "phone_number" : 6281333645444,
  "role" : {
    "id" : 2,
    "name" : "Operator"
  },
  "client" : {
    "id" : 1,
    "name": "Politeknik Pelayaran Surabaya",
    "phone_number" : 6281217018168,
    "email" : "cs@poltekpel.com"
  }
}