Calling An Action On The Server; About Parameters - MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Use Manual

Calling an action on the server

To call an action on the Breeze server, pass the relevant parameters to the web services servlet at
http://server_name/api/xml.
In Breeze 4.0, there are two parameters that are required for all actions: the parameter named
specifies the name of the action, and the parameter named
action
account's access key. In Breeze 4.1, you do not need to pass the
parameter in Breeze 4.1 is not harmful, it is ignored.
accesskey
Most actions also have other parameters. For more information about access keys, see
security" on page
the action's documentation in
You can send the parameters to the server in either of the following ways:
•
Create a query string—a URL that includes query parameters—and send it to the server as an
HTTP or
GET
x-www-form-urlencoded"
when you use this approach.)
The URL to use for the query string has the form
xml?action=action_name&accesskey=access_key
appended as additional query parameters separated by ampersands (&).
•
Create an XML object containing the parameter data as
and then send an HTTP
.
"text/xml"
For example code demonstrating how to call an action, see
page 27.
Note: The example code in this book uses the query parameters approach, both for readability and
because of limitations in using CFML to send XML objects containing parameter data. Macromedia
recommends using the
, using may provide higher security levels than passing parameters in the query string. For
POST POST
more information, see

About parameters

For most actions, you can specify one or more additional parameters. (The
parameters are required. For more information, see
action
on page 15.)
You usually specify parameters as name-value pairs, but the exact process depends on the details of
the language you use to call the action on the Breeze server. For sample code in ColdFusion
Markup Language (CFML), see
In the documentation for each action, all listed parameters are required except for those
specifically marked as optional.
17. For more information about additional parameters for a given action, see
Chapter 4, "Action Reference," on page
request, with the HTTP content type set to
POST
. (In most cases, you don't need to explicitly set the content type
request to the server, with the HTTP content type set to
POST
method when possible; because of the way HTTP implements
POST
"About security" on page
Chapter 3, "Common Tasks," on page
accesskey
accesskey
"application/
http://breeze.example.com/api/
, with the action's other parameters
tags contained in a
param
Chapter 3, "Common Tasks," on
17.
"Calling an action on the server"
specifies the
parameter. Passing the
"About
37.
params
and
GET
and
accesskey
27.
About parameters
tag,
15