3. Internal User (Emlpoyee)

Working with Employeers you have the following features:

Create a user

Update a user

List the of users per counterparty

Show a user

Create a user

An internal user created via the API or Internal web UI must have fields about the counterparty. This is important for creating roles.

Internal user contains a user ID or login (email) or a unique name.

Internal user is linked to a single counterparty.

Internal user has a set of assigned roles.

create employees

post

create dcm employees

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
branch_namestringOptional

optional default ''

counterparty_guidstringOptional

CounterpartyGUID application guid from wallet

guidstringOptional

GUID if guid is zero, generate new random guid if guid exist return error

is_disabledbooleanOptional

optional default false

loginstringOptional

Login must be unique

namestringOptional

optional default == login

rolesstring[]Optional

optional default without roles

Responses
200
OK
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/employees HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "branch_name": "text",
  "counterparty_guid": "text",
  "guid": "text",
  "is_disabled": true,
  "login": "text",
  "name": "text",
  "roles": [
    "text"
  ]
}
{
  "guid": "text"
}

Update a user

update employees

put

update dcm employees

Path parameters
counterparty_guidstringRequired

Counterparty GUID

employee_guidstringRequired

Employee GUID

Body
branch_namestringOptional
is_disabledbooleanOptional
loginstringOptional
namestringOptional
rolesstring[]Optional
Responses
200
OK
application/json
put
PUT /api/v1/counterparty/{counterparty_guid}/employees/{employee_guid} HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "branch_name": "text",
  "is_disabled": true,
  "login": "text",
  "name": "text",
  "roles": [
    "text"
  ]
}
{
  "guid": "text"
}

List the of users per counterparty

Show a user

To show a single user you should do the previuos request and to find the user you need with an appropriate guid.

Last updated