.. Netfiles API documentation master file, created by
   sphinx-quickstart on Fri Mar  6 11:42:21 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Get Children
==============

The ``getChildren`` call will allows you to retrieve information about the children of a given parent
object.

If the object in question is a leaf-object (represented as a *file*), you will receive an error. 
Otherwise you will receive an array of HW_Objects

Request
-------

Request method is ``getChildren``:

::

  GET https://app.netfiles.de/<dataroom-name>/projectfiles/<parentname>;internal&action=json&apikey=<YourApiKey>&deviceID=<currentDeviceID>&method=getChildren
  Authorization: Basic BASE64(UTF8Bytes(<username>:<password>))
  Accept: application/json
  User-Agent: iPad
  netfiles: <value of the netfiles cookie>
  sk1: <value of the sk1 cookie>
  HW_User: <value of the HW_User cookie>
  HyperwaveSession: <value of the HyperwaveSession cookie>
  sk_s_web_S: <value of the sk_s_web_S cookie>
  sk_p_web_S: <value of the sk_p_web_S cookie>


Response
--------

The response is a json object (``application/json``) representing a list of HW_Objects:

E.g.:

.. code:: json

    {
      "count": 4,
      "response": [
        {
          "type": "document",
          "id": "ID-29855.6432902402691-2",
          "path": "/tombusinessplus/projectfiles/anders.txt",
          "icon": "text",
          "documentClass": "",
          "version": "V 02",
          "downloadProhibited": false,
          "title": "anders.txt",
          "name": "anders.txt",
          "creationDate": "2019/10/09 10:00:32 +0000",
          "modificationDate": "2019/10/09 10:05:23 +0000",
          "author": "   ",
          "writeAccess": false,
          "documentType": "text/plain",
          "md5Checksum": "55b56a1400ea438c8cc912351b8187fa",
          "documentSize": 7
        },
        {
          "type": "document",
          "id": "ID-29855.6432902402705-1",
          "path": "/tombusinessplus/projectfiles/Hilfetexte.txt",
          "icon": "text",
          "documentClass": "",
          "version": "V 01",
          "downloadProhibited": false,
          "title": "Hilfetexte.txt",
          "name": "Hilfetexte.txt",
          "creationDate": "2019/10/09 10:24:45 +0000",
          "modificationDate": "2019/10/09 10:24:45 +0000",
          "author": "   ",
          "writeAccess": false,
          "documentType": "text/plain",
          "md5Checksum": "6cfbbbf7b35af5901a9fc9488bb45376",
          "documentSize": 1434
        },
        {
          "type": "document",
          "id": "ID-29855.6480642866403-1",
          "path": "/tombusinessplus/projectfiles/Ümlaüte şirkeğiıİ.png",
          "icon": "image",
          "documentClass": "",
          "version": "V 01",
          "downloadProhibited": false,
          "title": "Ümlaüte şirkeğiıİ.png",
          "name": "Ümlaüte şirkeğiıİ.png",
          "creationDate": "2020/03/10 13:06:28 +0000",
          "modificationDate": "2020/03/10 13:06:27 +0000",
          "author": "   ",
          "writeAccess": false,
          "documentType": "image/png",
          "md5Checksum": "a76d625e1c1136799df4f1583a8c6ef7",
          "documentSize": 52618
        },
        {
          "type": "collection",
          "id": "ID-29855.6480642866411-1",
          "path": "/tombusinessplus/projectfiles/Über den Berğen, beı den Şieben Zwergen",
          "documentClass": "",
          "version": "",
          "downloadProhibited": false,
          "title": "Über den Berğen, beı den Şieben Zwergen",
          "name": "Über den Berğen, beı den Şieben Zwergen",
          "creationDate": "2020/03/10 13:09:33 +0000",
          "modificationDate": "2020/03/10 13:09:33 +0000",
          "author": "   ",
          "writeAccess": true,
          "subDocs": "0"
        }
      ]
    }

In the example above, we have provided you with filenames including Turkish characters. We will keep this dataroom as example
for the future (``tombusinessplus``)

The result above was generated using the following call:

:: 

  GET https://is.netfiles.de/tombusinessplus/projectfiles;internal&action=json&apikey=<YourApiKey>&deviceID=<currentDeviceID>&method=getChildren


Returned Headers and Set Cookies are the same as with the :doc:`Check Identity <checkidentity>` call.