Developer’s Guide

B-6 Developer’s Guide
Specifying parameters for the request
The following are the parameters for requesting FileMaker Pro data
in XML format. Some parameters are required to be present in the
CGI command along with certain requests; others are optional.
–db (Database)
Name/Value Type: Parameter
What it does: Specifies the database that all processing for the
request will refer to.
Value is: Name of the database, including the extension if any. The
FileMaker Pro Web Companion uses only the name of the database;
do not include any path information. The database must be open in
FileMaker Pro.
Required with: All requests except the –dbnames request
Example:
FMPro?–db=employees.fp5&–format= –fmp_xml&–find
–lay (Layout)
Name/Value Type: Parameter
What it does: Specifies the layout that is used in the database. The
–lay parameter is used in –find, –findall, and –findany requests to
specify the fields that are returned and in –view requests to specify
the layout information that’s returned.
Value is: Name of the layout to use. If no layout is given, then the layout
is considered to contain all fields in the database (but not related fields).
Required with: –view requests, and –edit or –new requests for data
in related fields or portals
Optional with: –find, –findall, or –findany requests
Example:
FMPro?–db=employees.fp5&–format= –fmp_xml&–lay=
LayoutOne&–view
–format (Format)
Name/Value Type: Parameter
What it does: Specifies the XML grammar used for returning the
results of a request.
Value is:
–dso_xml, –dso_xml_dtd, –fmp_xml, or –fmp_xml_dtd.
Required with: All requests
Examples:
–recid (Record ID)
Name/Value Type: Parameter
What it does: Defines which record should be operated on. Used
mainly by the –edit, and –delete requests.
Value is: A record ID, which is a unique specifier to a record in a
FileMaker Pro database.
Required with: –edit and –delete requests
To generate this
XML grammar Specify this format
FMPDSORESULT FMPro?–db=employees.fp5&–format=
"–dso_xml"&–find
FMPDSORESULT
+ document type definition
FMPro?–db=employees.fp5&–format=
"–dso_xml_dtd"&–find
FMPXMLRESULT FMPro?–db=employees.fp5&–format=
"–fmp_xml"&–find
FMPXMLRESULT + document
type definition
FMPro?–db=employees.fp5&–format=
"–fmp_xml_dtd"&–find
FMPXMLLAYOUT FMPro?–db=employees.fp5&–format=
"–fmp_xml"&–view
FMPXMLLAYOUT + document
type definition
FMPro?–db=employees.fp5&–format=
"–fmp_xml_dtd"&–view