Dokumentasi API Public item

A. CREATE
B. PATCH
C. PUT
D. GET

CREATE

x-api-key: 1qWTFctHhzN3ysv6jHu9iaMtE3IYxRep
body:
{
"itemRefId": "123123:12",
"itemBelongsTo":"cgkkml",
"itemStartTime":"2021-06-18 01:00:00",
"itemEndTime":"2021-06-19 01:00:00",
"orNumber": [
{
"id":"106610750966",
"itemStatus": "Spare OR",
"listItemSubTitle": "106610750966"
},
{
"id":"106610750967",
"itemStatus": "Remarks",
"listItemSubTitle": "106610750967"
}
],
"sealBag":[
{
"id": "10",
"listItemSubTitle":"10",
"bagSeal": "10"
}
]
}
4. response
{
"status": true,
"message": "Success data saved!",
"data": {
"itemRefId": "123123:12",
"itemBelongsTo": "cgkkml",
"itemStartTime": "2021-06-18 01:00:00",
"itemEndTime": "2021-06-19 01:00:00",
"orNumber": [
{
"id": "106610750966",
"itemStatus": "Spare OR",
"listItemSubTitle": "106610750966"
},
{
"id": "106610750967",
"itemStatus": "Remarks",
"listItemSubTitle": "106610750967"
}
],
"sealBag": [
{
"id": "10",
"listItemSubTitle": "10",
"bagSeal": "10"
}
],
"created_by": "admin",
"_id": "32cd6d96f946d54bb9ed",
"itemStatus": "available",
"organization_id": "5bb3388b6c49613e03728944",
"isDeleted": false,
"created_at": "2021-06-18 17:38:07",
"updated_at": "2021-06-18 17:38:07"
}
}

PATCH

Setiap parameter yang dikirim akan menimpa/overwrite data yang ada di server
x-api-key: 1qWTFctHhzN3ysv6jHu9iaMtE3IYxRep
body:
{
"sealBag": [
{
"id": "11,
"listItemSubTitle": "11",
"bagSeal": "11"
}
]
}
4. response
{
"status": true,
"message": "Success edit",
"data": {
"_id": "32cd6d96f946d54bb9ed",
"itemRefId": "123123:12",
"itemBelongsTo": "cgkkml",
"itemStartTime": "2021-06-18 01:00:00",
"itemEndTime": "2021-06-19 01:00:00",
"orNumber": [
{
"id": "106610750966",
"itemStatus": "Spare OR",
"listItemSubTitle": "106610750966"
},
{
"id": "106610750967",
"itemStatus": "Remarks",
"listItemSubTitle": "106610750967"
}
],
"sealBag": [
{
"id": "11",
"listItemSubTitle": "11",
"bagSeal": "11"
}
],
"created_by": "admin",
"itemStatus": "available",
"organization_id": "5bb3388b6c49613e03728944",
"isDeleted": false,
"created_at": "2021-06-18 17:38:07",
"updated_at": "2021-06-18 17:39:06",
"updated_by": "admin"
}
}

GET

keterangan: url/public/v2/item/{_id} atau url/public/v2/item/{itemRefId}
x-api-key: 1qWTFctHhzN3ysv6jHu9iaMtE3IYxRep
response:
{
"status": true,
"message": "Success",
"data": {
"_id": "32cd6d96f946d54bb9ed",
"itemRefId": "123123:12",
"itemBelongsTo": "cgkkml",
"itemStartTime": "2021-06-18 01:00:00",
"itemEndTime": "2021-06-19 01:00:00",
"orNumber": [
{
"id": "106610750966",
"itemStatus": "Spare OR",
"listItemSubTitle": "106610750966"
},
{
"id": "106610750967",
"itemStatus": "Remarks",
"listItemSubTitle": "106610750967"
}
],
"sealBag": [
{
"id": "11",
"listItemSubTitle": "11",
"bagSeal": "11"
}
],
"created_by": "admin",
"itemStatus": "available",
"organization_id": "5bb3388b6c49613e03728944",
"isDeleted": false,
"created_at": "2021-06-18 17:38:07",
"updated_at": "2021-06-18 17:39:06",
"updated_by": "admin"
}
}

PUT

Menghapus semua property/data kecuali yang ada di dalam body request
keterangan: url/public/v2/item/{_id}
x-api-key: 1qWTFctHhzN3ysv6jHu9iaMtE3IYxRep
body:
{
"itemBelongsTo": "cgkkml", //wajib ada
"sealBag": [
{
"id": "12",
"listItemSubTitle": "12"
}
]
}
4. response
{
"status": true,
"message": "Success update",
"data": {
"_id": "32cd6d96f946d54bb9ed",
"itemBelongsTo": "cgkkml",
"sealBag": [
{
"id": "12",
"listItemSubTitle": "12"
}
],
"created_by": "admin",
"organization_id": "5bb3388b6c49613e03728944",
"isDeleted": false,
"created_at": "2021-06-18 17:38:07",
"updated_at": "2021-06-18 17:44:50",
"updated_by": "admin"
}
}
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.