"alterSession"

• The "binaryFormat" property may occur inside "params",  "responseOptions", "defaultResponseOptions" , and "result".

• When "binaryFormat" occurs in "params" it specifies how the sender represents binary values.

  For example, when  "binaryFormat" is set to "hex", the FairCom server expects the binary values of fields and keys to be represented in strings with hexadecimal format.

• When "binaryFormat" occurs in "responseOptions" or "defaultResponseOptions" it specifies how the FairCom server should represent binary values in responses.

  For example, when "binaryFormat" is set to "hex", the FairCom server represents binary values in strings with hexadecimal format.

• When "binaryFormat" occurs in "result" it signifies how binary values are represented.

  For example, when "binaryFormat" is set to "base64", the FairCom server represents binary values in the response in base64 format.

• The following are the possible values for each format.

  • "base64"

    When the server reads and writes from a binary field, it represents the binary value as a base64 string.

    • Base64 is harder for people to read and convert to binary.

    • Base64 creates the smallest payload for the most efficient data transmission in JSON.

    • "base64" strings contain the characters 0 - 9 , A - Z, a - z, +, /, and =.

  • "hex"

    When the server reads and writes from a binary field, it represents the binary value as a hexadecimal string.

    • Hexadecimal is easier for people to read and convert to binary.

    • Hexadecimal creates a 30% larger payload than "base64", which makes it less efficient for data transmission.

    • Hexadecimal strings contain the characters 0 - 9 and A - F.

  • "byteArray"

    When the server reads and writes from a binary field, it represents the binary value as an array of bytes.

    • An array of bytes is easiest for a program to manipulate.

    • An array of bytes creates a larger payload than "base64" and "hex", which makes it less efficient for data transmission.

    • An array of bytes returns a JSON array containing one integer number between 0 and 255 for each byte in the binary value:

      • "aBinaryField": [ 255, 0, 255 ]

• See Object owner in the JSON DB Concepts section for an explanation of how to use the "defaultOwnerName" property to specify the owner of objects created in the session

• When "ownerName" is omitted the server uses the "defaultOwnerName" property value set during login.

• In "createSession" and "alterSession" when "defaultOwnerName" is omitted or set to null:

  • In the JSON DB API, the server sets "defaultOwnerName" to the "username" of the logged-in user. Thus, by default, the logged-in account owns the objects it creates.

  • In the JSON Hub API and JSON MQ API, the server sets "defaultOwnerName" to "admin" allowing the server to own the objects it creates.

• Actions that create objects, such as "createTable" and "createIntegrationTable", can omit the "ownerName" property making the server set "ownerName" to the value of "defaultOwnerName".

• When an action that creates an object sets the "ownerName" property to a valid account name, the specified account owns the created object and an account that owns an object has full management rights over the object. You can use object ownership as a simple way to control access to objects.

• When "ownerName" is set to the empty string, then no account owns the object. Unowned objects can be managed by administrator accounts and by accounts assigned to roles that grant access rights to the object making it useful when you want to prevent an account from owning an object and inheriting full management rights to that object.

• 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 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.

• 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.

• 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.