Page History

<Target Format>

Result format (XMLGetXML, JSONGetJSON, HTMLor GetHTML).  The Target Format is preceded with Use the prefix “Get” Get followed by the format (one of XML, JSON, or HTML) concatenated as one word. :  

• If your Target Format

• is XML, use … /GetXML?query= …

• to return Target in the form XML.
• If your Target Format

• is JSON

• , use … /GetJSON?query= …

• to return Target in the form JSON.
• If your Target Format

• is HTML

• , use … /

• GetHTML?query= …

• to return Target in the form HTML.

<Target>

Result class name. Use a valid caDSR Class name.  (One of DataElement, Form, …), such as DataElement or Form. For a full list, refer to the caDSR II Domain Class Browser:

https://cadsrapi.cancer.gov/caDSR/domain/browser.dsp

For example, use …  e.g.  … query=Form[ … ]   will to return caDSR Form class information.

<Criteria>

The criteria class that identifies the association to be traversed when retrieving the target/result class.    The The Criteria will constrain the target/result based on the associated id/id value ID and ID_VALUE pair or pairs provided that you provide in the braces square brackets [ … ].

Note: The Criteria can be nested within the braces You can nest Criteria in the square brackets [ … ]. If the Criteria =is the Target, then a short hand can be used and the Criteria is assumed you can use a shorthand and the system assumes the Criteria to be equal to the Target. (this is referred to as an This is considered Implicit Criteria.).

• Implicit Example: Use GetXML?query=DataElement[

• @publicId=62]

• to return a Data Element with Data Element

• publicId=62 in XML format.
• Nested and Implicit Example:

• Use GetXML?query=Form[Protocol[

• @preferredName=C3D ADOPTER TEMPLATES],

• @publicId=2392775]

• to return Form with Protocol preferredName=C3D ADOPTER TEMPLATES

• and Form publicId=2392775

<ID>

Attribute of the Criteria class used to constrain the query.   For more than one attribute, use a comma between each attribute.   The query will perform performs the “AND” AND operation for all id/id value all ID and ID_VALUE pair parameters you have provided for the Criteria class class you have identified.

• For version: Do not use both @version and @latestVersionIndicator together. Specify @publicId=x,@version OR specify @publicId=x,@latestVersionIndicator.
• Otherwise, one or more ID-criteria pairs may be used.

For example, use [@publicId= …] e.g. [@publicId= …]  combined with the ID_VALUE below will be used to identify the constraints for the result returned.

<ID_VALUE>

A string identifying the qualified criteria class data to be used as a filter on the result set.  1 or more id-criteria pair may be used.

e.g. [@publicId=62,@version=6] 

:

• For @latestVersionIndicator use =Yes or =No. Yes returns the latest version of the publicId, No returns all versions. 

For example, use [@publicId=62,@version=6] to identify a qualified criterion for the class specified in <Target>.