The following parameters are supported by all Luminate Online Open APIs, both Client APIs and Server APIs:
Required. The method to be invoked. Method names are case-sensitive, and by convention begin with a lower-case letter with camel-cased words.
Type xsd:string
Required. The version number for the API. Currently only version 1.0 is supported.
Type xsd:string
Required. An arbitrary value that must be passed when invoking the Luminate Online Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each site. This value will be the same for all API methods. Note that this value is not considered secure and may be visible to end users.
Type xsd:string
Optional. The desired response format. Either "xml" or "json" may be specified. If no value is specified, then "xml" is the default.
Type xsd:string
Optional. The ID of a center (in a multi-center enabled site) to associate with the current session.
Type xsd:nonNegativeInteger
Optional. Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created.
Type xsd:string
Optional. Further detail to save with the "source" information.
Type xsd:string
The following parameters are supported by Luminate Online Client APIs:
Optional. Specifies a URL redirect to send back to the browser after processing if an error has occurred.
Type xsd:anyURI
Optional. Specifies a URL redirect to send back to the browser after successful processing.
Type xsd:anyURI
Optional. Specifies a URL redirect to send back to the browser after successful processing.
Type xsd:anyURI
Optional. Indicates that redirect URLs should include a digital signature. The digital signature consists of two additional parameters in the URL. The ts parameter will contain a timestamp associated with the completion of the API call. The sig parameter will contain an MD5 hash of the URL query string up to but not including the sig parameter, and the CONVIO_API_SECRET_KEY value.
Type xsd:boolean
Optional. Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If true, the client must determine error states by parsing the response body. Default is false.
Type xsd:boolean
The following parameters are supported by all Luminate Online Server APIs:
Required for server API calls, invalid for client API calls. The user_name of the administrative account that was created for API access. Note that this must be a special administrator account used just for API access.
Type xsd:string
Required for server API calls, invalid for client API calls. The password of the administrative account that was created for API access. Note that this must be a special administrator account used just for API access.
Type xsd:string
Comments