Common Parameters

Request Keys

In addition to the page and Authentication request values, the StrandVision API includes several optional values that can be sent.

x-ApiResponse - Force the API response to be formatted as either JSON and XML. x-ApiConsolidate - Consolidates responses to reduce bandwidth by removing empty response values along with other information that can be gathered elsewhere. Valid options are 0 and 1. x-LogLevel - Specify the log level for this call. This defaults to 0 which reduces the information that is stored for each call. Set to 1 to store server name, user agent and request url. Set to 2 or higher to save raw request and response information. This is used with a subsequent api/Read/Log endpoint with the RequestId that is returned in the headers.

Response Keys

Most StrandVision API calls return special HTTP header responses that contain information about the responses that are sent.

x-RequestId - A unique identifier of the API call that was sent if logging is enabled or an error occurred. Use the value of this header to help identify your request for your own purposes, to retrieve the log or when contacting StrandVision support. x-RequestKeyId - The database index id for the api key you passed. x-RequestLimit - If your account is rate limited, this is returned with the maximum number of requests that can be sent before the rate limit is exceeded. x-RequestRemain - If rate limited, this is returned with the number of requests remaining before the rate limit is exceeded. x-RequestReset - If rate limited, this is when the counter will be reset.