Skip to content

Commit

Permalink
Updated docs: applications
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitry Sikorsky committed Mar 17, 2016
1 parent 0119226 commit 6e8e7aa
Show file tree
Hide file tree
Showing 6 changed files with 264 additions and 1 deletion.
53 changes: 53 additions & 0 deletions docs/api/applicationformquestion.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
ApplicationFormQuestion
=======================

Base URL: /api/v1/{format}/applicationformquestions

where

{format} is 'json' or 'xml'.

Each request requires additional parameter access_token.

Create
------

url: /
method: POST
params: entity (ApplicationFormQuestion)

Update
------

url: /{id}
method: PUT
params: entity (ApplicationFormQuestion)

Delete
------

url: /{id}
method: DELETE
params:

Find All
--------

url: /
method: GET
params:
example: /api/v1/json/applicationformquestions?access_token={yourToken}

Find One
--------

url: /{id}
method: GET
params:

Find by Name
------------

url: /
method: GET
params: name (String)
53 changes: 53 additions & 0 deletions docs/api/applicationformquestiongroups.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
ApplicationFormQuestionGroup
============================

Base URL: /api/v1/{format}/applicationformquestiongroups

where

{format} is 'json' or 'xml'.

Each request requires additional parameter access_token.

Create
------

url: /
method: POST
params: entity (ApplicationFormQuestionGroup)

Update
------

url: /{id}
method: PUT
params: entity (ApplicationFormQuestionGroup)

Delete
------

url: /{id}
method: DELETE
params:

Find All
--------

url: /
method: GET
params:
example: /api/v1/json/applicationformquestiongroups?access_token={yourToken}

Find One
--------

url: /{id}
method: GET
params:

Find by Name
------------

url: /
method: GET
params: name (String)
53 changes: 53 additions & 0 deletions docs/api/applicationforms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
ApplicationForm
===============

Base URL: /api/v1/{format}/applicationforms

where

{format} is 'json' or 'xml'.

Each request requires additional parameter access_token.

Create
------

url: /
method: POST
params: entity (ApplicationForm)

Update
------

url: /{id}
method: PUT
params: entity (ApplicationForm)

Delete
------

url: /{id}
method: DELETE
params:

Find All
--------

url: /
method: GET
params:
example: /api/v1/json/applicationforms?access_token={yourToken}

Find One
--------

url: /{id}
method: GET
params:

Find by Name
------------

url: /
method: GET
params: name (String)
53 changes: 53 additions & 0 deletions docs/api/applicationformstep.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
ApplicationFormStep
===================

Base URL: /api/v1/{format}/applicationformsteps

where

{format} is 'json' or 'xml'.

Each request requires additional parameter access_token.

Create
------

url: /
method: POST
params: entity (ApplicationFormStep)

Update
------

url: /{id}
method: PUT
params: entity (ApplicationFormStep)

Delete
------

url: /{id}
method: DELETE
params:

Find All
--------

url: /
method: GET
params:
example: /api/v1/json/applicationformsteps?access_token={yourToken}

Find One
--------

url: /{id}
method: GET
params:

Find by Name
------------

url: /
method: GET
params: name (String)
46 changes: 46 additions & 0 deletions docs/api/applications.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Applications
============

Base URL: /api/v1/{format}/applications

where

{format} is 'json' or 'xml'.

Each request requires additional parameter access_token.

Create
------

url: /
method: POST
params: entity (Application)

Update
------

url: /{id}
method: PUT
params: entity (Application)

Delete
------

url: /{id}
method: DELETE
params:

Find All
--------

url: /
method: GET
params:
example: /api/v1/json/applications?access_token={yourToken}

Find One
--------

url: /{id}
method: GET
params:
7 changes: 6 additions & 1 deletion docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,9 @@ Root for the all relative URLs is 'http://ivis.dev.imcode.com/';

authorization
schools
schoolclasses
schoolclasses
applications
applicationforms
applicationformsteps
applicationformquestiongroups
applicationformquestions

0 comments on commit 6e8e7aa

Please sign in to comment.