Client API v2

From Memsource
Jump to: navigation, search

Create New Client

action: api/v2/client/create
    token                       string
    name                        string
    externalId                  string             O
                        

response: JSON
    {
      "id": 238                 // id of the new client
    }

Get Client

action: api/v2/client/get
    token                       string
    client                      domain(Client)

response: JSON
   {
     "id":3,
     "name":"client",
     "externalId":"1234567"
   }

List Clients

action: api/v2/client/list
    token                       string
    page                        integer            O(0)
    name                        string             O

response: JSON
   [
     {
       "id":3,
       "name":"client"
       "externalId":"1234567"
     }
   ]

Edit Client

action: api/v2/client/edit
    token                       string
    client                      domain(Client)
    name                        string             0
    externalId                  string             0

response: empty

Delete Client

action: api/v2/client/delete
    token                       string
    client                      domain(Client)

response: empty