Skip to content

Client API

atsanan edited this page Sep 16, 2020 · 5 revisions

1. Client

[x] 1.1 Get Client list

GET /api/v1/client/list?page=0&limit=10

Query parameters:

Field Description Optional Default Auth
page Current page of Card list Yes 0 Yes
limit Maximum page of Card list Yes 10 Yes

Returns:

{
    "data": {
        "client": [
            {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "clientCode":"card2u",
                "clientName":"Card2U Client",
                "email":"card2u@ecartstudio.com",
                "mobile":"987654321",
                "status":true,
                "updated_at": "2020-09-16T22:35:30Z"
            }
        ],
        "pageIndex": -1,
        "pageLimit": -1,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 1.2 Get Client Detail

GET /api/v1/client/{id:string}

Returns:

{
    "data": {
        "client": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "clientCode":"card2u",
                "clientName":"Card2U Client",
                "email":"card2u@ecartstudio.com",
                "mobile":"987654321",
                "status":true,
                "updated_at": "2020-09-16T22:35:30Z"
            },
  
    },
    "isSuccess": true
}

[x] 1.3 Add Client

POST /api/v1/client/add

Form data:

Field Description Optional Auth
clientKey No
clientCode No
clientName No
email No
mobile No
status No

Returns:

{
    "data": {
        "client": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "clientCode":"card2u",
                "clientName":"Card2U Client",
                "email":"card2u@ecartstudio.com",
                "mobile":"987654321",
                "status":true,
                "updated_at": "2020-09-16T22:35:30Z"
            },
  
    },
    "isSuccess": true
}

[x] 1.4 Edit Client

POST /api/v1/client/{id}

Form data:

Field Description Optional Auth
clientKey No
clientCode No
clientName No
email No
mobile No
status No

Returns:

{
    "data": {
        "client": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "clientCode":"card2u",
                "clientName":"Card2U Client",
                "email":"card2u@ecartstudio.com",
                "mobile":"987654321",
                "status":true,
                "updated_at": "2020-09-16T22:35:30Z"
            },
  
    },
    "isSuccess": true
}

[x] 1.5 Delete Client

DELETE /api/v1/client/{id}

Returns:

{
    "data": {
        "message": "Success Delete"
    },
    "isSuccess": true
}

Clone this wiki locally