Skip to content

Latest commit

 

History

History
115 lines (104 loc) · 3.01 KB

clients.md

File metadata and controls

115 lines (104 loc) · 3.01 KB
Raw

Get All Clients

GET /client

Returns the list of Clients, e.g.:

[
    {
        "_id": "59c9fa822eb949496346ed85",
        "name": "customer2",
        "metadata": null,
        "createdDate": "2017-09-26T06:58:10.528Z",
        "updatedDate": "2017-09-26T07:00:30.083Z"
    },
    {
        "_id": "59cb3a0c242639540481a196",
        "name": "customer1",
        "metadata": "very important customer",
        "createdDate": "2017-09-27T05:41:32.059Z"
    }
]

The following is a description of the properties in the response.

Property Type Description Required Sortable
_id string id of the Client NO NO
name string Client name YES YES
metadata string Client metadata NO NO
createdDate string Created Date NO YES
updatedDate string Updated Date NO YES
deleted boolean Deleted Date NO NO

Search Clients

POST client/search

If you only want a client with certain name as customer1.

{"name" : "customer1" }

will return all clients which are NOT customer2

{"name" : {"$nin": ["customer2"] } }

will return all clients which have 112233 and 1d39e0 values in metadata

{"metadata" : {"$in": ["112233", "11d39e0"] } }

will return all clients which have partially 11 in value in metadata

{"metadata" : {"$like": "11" } }

Search Parameters

Use paramters to narrow you search. For example use $nin for not included, and use $in for included.

Property Parameters
$nin not included
$in included
$like includes (also partial) string

Searchable Properties

Property Parameters Description
metadata $nin, $in, $like custom meta data field
name $nin, $in, $like client name

A successful search will return a 200 Ok response status from the server.

Create a new Client

POST /client

An example of a Client

{"name": "sample_client"}

The server will return the full client object once created including the newly created client ID _id

{
    "_id": "59cb91f41900f95ce6961d24",
    "name": "sample_client",
    "metadata": null,    
    "createdDate": "2017-09-27T11:56:36.901Z"
}

Update an existing Client

PUT /client/123456789012

will update the Client with the id 123456789023. Only "name" property update is available"

{"name": "sample_updated_client"}

A successful update will return a 200 Ok response status from the server.

Delete a Client

Use the following command to delete an existing Client by id.

DELETE /client/123456789012

Will delete Client with the id 123456789012

A successful delete will return a 200 Ok response status from the server.

Get an existing Client

Use the following command to get a specific Client by id.

GET /client/123456789012

Will return Client with the id 123456789012

The server should return the full Client object and a 200 Ok response status.