Skip to content

Commit

Permalink
IVIS-46: - Update API chapter (roles).
Browse files Browse the repository at this point in the history
  • Loading branch information
RuslanPopenko committed Oct 26, 2016
1 parent da0cc26 commit 116c5b7
Showing 1 changed file with 7 additions and 29 deletions.
36 changes: 7 additions & 29 deletions docs/api/roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Provides following method for `API <index.html>`_ calls:
* `Save roles`_
* `Update role`_
* `Delete role`_
* `Get role or roles by personal id`_
* `Get role or roles by name`_

.. _`Get role`:
Expand Down Expand Up @@ -71,8 +70,8 @@ Parameters response:
*Array*

.. seealso::
Array consists of objects from `Get role`_ method

Array consists of objects from `Get role`_ method

Save role
---------
Expand Down Expand Up @@ -141,8 +140,8 @@ Parameters response:
*OBJECT(Role)*

.. note::
property will be updated, if you don't want update property it need set null

property will be updated, if you don't want update property it need set null

.. _`Delete role`:

Expand All @@ -166,29 +165,8 @@ Parameters response:
*OBJECT(Role)*

.. note::
you receive deleted object

.. _`Get role or roles by personal id`:

Get role or roles by personal id
-----------------------------

URL:
~~~~
*/roles
Method:
~~~~~~~
*GET*

Parameters request:
~~~~~~~~~~~~~~~~~~~
*personalId(STRING)*
*first(BOOLEAN)* - optional

Parameters response:
~~~~~~~~~~~~~~~~~~~~
*ARRAY or OBJECT (Role)*
you receive deleted object

.. _`Get role or roles by name`:

Expand All @@ -197,7 +175,7 @@ Get role or roles by name

URL:
~~~~
*/roles
*/roles*

Method:
~~~~~~~
Expand All @@ -206,7 +184,7 @@ Method:
Parameters request:
~~~~~~~~~~~~~~~~~~~
*name(STRING)*
*first(BOOLEAN)* - optional
and optional *first(BOOLEAN)*

Parameters response:
~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 116c5b7

Please sign in to comment.