`mkdir` (Create a directory)

The mkdir transaction creates a directory. The API will check the permission of the user and create the directory only if the user calling the transaction is authorized to create a directory in the parent folder.

Query string

The query string in the HTTP header must contain the following parameters:

api

Specify the name of the API transaction.

apiversion

Specify the version of the API that should handle the requested transaction.

For the most up-to-date version, use apiversion=3.

uid

Specify a valid 1010data user name.

pswd

Specify a valid password for the 1010data user name provided to the uid parameter.

Note: The pswd value should be the encrypted password returned from the login transaction.

sid

The session ID for the current API session.

This value is returned by the login transaction and must be provided to every transaction (except login).

kill (optional)

Valid values for kill are as follows:

yes: Terminate the existing session and start a new one.
no: Do not terminate the existing session.
If no session exists, a new one will be created. If a session does exist, an error is returned.

Note: If kill=no and a session is active, the system returns an error.
possess: Log in and possess the existing session.
auth: Authenticate with the system but do not kill, possess, or start any session.

The default is yes.

XML input to server

The specifications must contain the following elements:

<name>: The full name of a directory. Directory names are specified as a full path to the location of the directory, e.g., directory1.directory2.directory[N].thisdirectory.
<users>: Contains <user> elements, each containing a UID that is authorized to view the directory or table.
See Users Tree for the XML schema.
<uploaders>: Contains <uploader> elements, each containing a UID that is authorized to modify the directory or table.
See Users Tree for the XML schema.
<title>: The title of the directory or table.

XML response from server

A successful response from the server contains the following elements:

<rc>: The return code generated by the transaction. For a list of return codes, see Return codes.
<msg>: The message returned by the system. Specific messages correspond to specific return codes.
<name>: The full name of a directory. Directory names are specified as a full path to the location of the directory, e.g., directory1.directory2.directory[N].thisdirectory.

The directory metadata is returned as a series of attributes contained within the <dir> element. The attributes are as follows:

Query string example

https://www2.1010data.com/gw.k?api=mkdir&apiversion=3&uid=$UID&pswd=$PSWD&sid=$SID

XML input example

<in>
  <name>certification.apitests</name>
  <users type="list">
    <user>cp_training1</user>
    <user>cp_training2</user>
  </users>
  <upload type="list">
    <user>cp_trainer1</user>
  </upload>
  <title>API Training</title>
</in>

XML response example

A successful mkdir produces the following result:

<out>
    <rc>0</rc>
    <name>certification.apitests</name>
    <msg>Mkdir Successful</msg>
</out>

mkdir (Create a directory)