getTagInfo

getTagInfo

Handles a request to get a tag's preview data and editor URL

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRContentAPI SRContentAPI POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRContentAPI?method=getTagInfo &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &content=value [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRContentAPI?method=getTagInfo & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & content =value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

content

Required. The string of content to be rendered by the Luminate Online template engine within the context of the caller's session. This may include one or more Session Tags and/or Conditional Tags, exactly as would be used within pages on the Luminate Online site. This string will be validated for syntax and returned in the response, with the validated pre-rendered string in the "source" field and the validated rendered string in the "preview" field.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

content

Required. The string of content to be rendered by the Luminate Online template engine within the context of the caller's session. This may include one or more Session Tags and/or Conditional Tags, exactly as would be used within pages on the Luminate Online site. This string will be validated for syntax and returned in the response, with the validated pre-rendered string in the "source" field and the validated rendered string in the "preview" field.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getTagInfoResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <preview>devnull@convio.com</preview>
  <description>Site Configuration: SITE_CONTACT_EMAIL</description>
  <source>&lt;convio:session param="SITE_CONTACT_EMAIL" name="100">&lt;/convio:session></source>
</getTagInfoResponse>

        
JSON response
{"getTagInfoResponse":{"source":"<convio:session param=\"SITE_CONTACT_EMAIL\" name=\"100\"><\/convio:session>","preview":"devnull@convio.com","description":"Site Configuration: SITE_CONTACT_EMAIL"}}

        

Leave a Comment

Nickname
Comment
Enter this word: