CRDataSyncAPI:listForeignObjectsForXrefField
servlet
method
The method name
api_key
An arbitrary value that must be passed when invoking the Convio 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 Convio site.
v
API version to invoke. Must be "1.0".
auth
Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
center_id
The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect
Specifies a URL that the method should redirect to in the event of an error.
redirect
Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format
Used to specify either XML or JSON formatting for the response.
sign_redirects
Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source
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.
sub_source
Further detail to save with the "source" information.
success_redirect
Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes
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 used, it's then the job of the client to determine error states by parsing the response body.
field_number
Field Number
type_id
XRef type ID
list_ascending
Whether the list should be sorted in ascending order.
list_filter_text
The text that will be used to filter results.
list_page_offset
The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
list_page_size
The number of results in each page (used with "list_record_offset" or "list_page_offset").
list_record_offset
The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
list_sort_column
The column to sort with (used with "list_ascending").
sso_auth_token
The auth token
login
servlet
method
v
api_key
user_name
password
logout
servlet
method
v
api_key
SRDataSyncAPI:listForeignObjectsForXrefField
servlet
method
The method name
api_key
An arbitrary value that must be passed when invoking the Convio 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 Convio site.
v
API version to invoke. Must be "1.0".
auth
Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
center_id
The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect
Specifies a URL that the method should redirect to in the event of an error.
redirect
Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format
Used to specify either XML or JSON formatting for the response.
sign_redirects
Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source
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.
sub_source
Further detail to save with the "source" information.
success_redirect
Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes
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 used, it's then the job of the client to determine error states by parsing the response body.
field_number
Field Number
type_id
XRef type ID
list_ascending
Whether the list should be sorted in ascending order.
list_filter_text
The text that will be used to filter results.
list_page_offset
The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
list_page_size
The number of results in each page (used with "list_record_offset" or "list_page_offset").
list_record_offset
The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
list_sort_column
The column to sort with (used with "list_ascending").
sso_auth_token
The auth token