"createSession"

• Possible values include:

  • "none"

  • "max"

• If "defaultDebug" is omitted or set to null, it defaults to "max".

  This causes the server to include the "debugInfo" property in the response.

  This setting is typically used in development environments and for temporarily troubleshooting issues in production environments.

• For maximum performance set set "defaultDebug" to "none" .

  This causes the server to omit the "debugInfo" property in the response.

  This setting is typically used in production and staging environments where it is desirable to have maximum performance and minimal network traffic.

• JSON NAV allows you to choose how your program detects errors. By default, all error properties are included in each response – unless you override this behavior as shown in the example.

• The example omits the error object in all responses and omitting the error object makes it easier for statically typed languages, such as C, C++, Java, C#, and VB, because they prefer properties to always be present. To help these languages, the "errorCode", "errorMessage", and "errorData" properties are always present whether there is an error or not.

Two of those versions occur in a request and another occurs in a response. They all indicate how data is formatted.

• "dataFormat" in the request inside "responseOptions" determines how the "data" property in the response is formatted.

  Possible values include:

  • "arrays"

    This is the default and causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

• "dataFormat" in the request in the "params" object notifies the server how the "sourceData" property is formatted in the request. This version is rarely used because of the default "autoDetect" behavior.

  Possible values include:

  • "arrays"

    This causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

  • "autoDetect"

    This is the default and causes the server to automatically detect the format of the data in the "sourceData" property.

• "dataFormat" in the response shows the client how the server formatted the "data" property.

  Possible values include:

  • "arrays"

    This is the default and causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

• Each time a session executes an operation, the session timer restarts.

• A value of 0 keeps a session open indefinitely.

• Each time a cursor retrieves records, the cursor timer restarts.

• A value of -1 keeps a cursor open indefinitely.

• A value of 0 immediately closes a cursor after the current operation.

• The "password" property is required by the "createSession" action for authentication.

• It is possible, but not recommended, for a password policy to allow a zero-length string.

• It is required by the "createSession" action for authentication.

• All API actions are performed in the context of the account identified by "username". For example, all tables created by an account are owned by the account. All queries use tables owned by the account.

• In JSON DB API and JSON Hub API, use the "ownerName" property to cause an action to use a different account name than the value of "username". This allows an account to use tables created by another account and to create tables that are owned by another account.

• Unlike other property names, such as "databaseName", "username" is all lowercase.

• A zero-length username is invalid.

• It is supplied by the server in response to the connect action.

• Clients must include it in all subsequent requests to validate that the client is authenticated and authorized. If the client does not supply the correct values, the server returns an unauthorized error.

• JSON NAV allows you to choose how your program detects errors. By default, all error properties are included in each response – unless you override this behavior as shown in the example.

• The example omits the error object in all responses and omitting the error object makes it easier for statically typed languages, such as C, C++, Java, C#, and VB, because they prefer properties to always be present. To help these languages, the "errorCode", "errorMessage", and "errorData" properties are always present whether there is an error or not.

Two of those versions occur in a request and another occurs in a response. They all indicate how data is formatted.

• "dataFormat" in the request inside "responseOptions" determines how the "data" property in the response is formatted.

  Possible values include:

  • "arrays"

    This is the default and causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

• "dataFormat" in the request in the "params" object notifies the server how the "sourceData" property is formatted in the request. This version is rarely used because of the default "autoDetect" behavior.

  Possible values include:

  • "arrays"

    This causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

  • "autoDetect"

    This is the default and causes the server to automatically detect the format of the data in the "sourceData" property.

• "dataFormat" in the response shows the client how the server formatted the "data" property.

  Possible values include:

  • "arrays"

    This is the default and causes the server to return results as an array of arrays, which is the most efficient.

  • "objects"

    This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

• Each time a session executes an operation, the session timer restarts.

• A value of 0 keeps a session open indefinitely.

• Each time a cursor retrieves records, the cursor timer restarts.

• A value of -1 keeps a cursor open indefinitely.

• A value of 0 immediately closes a cursor after the current operation.

• It is required by the "createSession" action for authentication.

• All API actions are performed in the context of the account identified by "username". For example, all tables created by an account are owned by the account. All queries use tables owned by the account.

• In JSON DB API and JSON Hub API, use the "ownerName" property to cause an action to use a different account name than the value of "username". This allows an account to use tables created by another account and to create tables that are owned by another account.

• Unlike other property names, such as "databaseName", "username" is all lowercase.

• A zero-length username is invalid.