Reference: Processes-XML Processing

General format

The following generalized format describes the XML "construct" for communication between XML enabled RidgeStar client sites and approved partners (ie. other approved Sites). This has been defined after review of the XML 1.0 specification from the W3C folks and associated documents. Individual elements (containers) can be repeated as necessary.

Elements in [braces] represent variable data, provided, as required, by the requesting Site. The constant ACRONYM should be replaced by the Source Site's common Acronym so that the XML has a framework to work within. ALL elements are treated as character strings and passed between trading partners as such. Characters outside a container are ignored. Indentation in the examples, as well as line breaks etc are for clarity only and are ignored during communications. Communications can be HTTPS (SSL), if it is available from the source site.

<ACRONYM version="2.0">
  <request name="[identifier]" table="[table-name]" max="[record-count]" key="[key#]" prefix="[code]">
    <user>[SiteName]</user>
    <password>[Password]</user>
    <display>
      <field name="[FieldName]"></field>
      ...
    </display>
    <show>
      <field name="[FieldName]">[value]</field>
      ...
    </show>
  </request>
  ...
</ACRONYM>

<ACRONYM version="2.0">
  <response name="[identifier]">
    <value>[return-code]</value>
    <message>[text message]</message>
    <display>
      <field name="[FieldName]">[value]</field>
      ...
    </display>
    <show max="[total-record-count]">
    	<record key="[key#]">
         <field name="[FieldName]">[value]</field>
         ...
      </record>
      ...
    </show>
  </response>
  ...
</ACRONYM>

Examples

Concept is to define a generalized structure that can be utilized for a variety of purposes, which is the basis of XML itself. Here's hoping these examples help clarify how it might be utilized.

Requesting Site would like to obtain the assigned Date for Match #1235

A XML file is constructed and sent to the appropriate destination in the Source site. The Request and corresponding Response can be represented as:

<ACRONYM>
<request name="Example1" table="Matches"  prefix="dma">
	<display>
		<field name="Key">12345</field>
		<field name="Date"></field>
	</display>
</request>
</ACRONYM>

ACRONYM.ORG responds with:

<ACRONYM version="6.3.0">
<response name="Example1" table="Matches"  prefix="dma">
	<value>0</value>
	<message>Success</message>
	<display>
		<field name="Key">12345</field>
		<field name="Date">2024-11-21</field>
	</display>
</response>
</ACRONYM>