Definitions and Conventions

Definitions of terms used in the API and explanation of common conventions used throughout.

Tag Names

In general complex objects are Capitalized.

Relations

One To One

These are wrapped in a tag that describes the child object's relationship to the parent object. For example <CreditAccount> might have a tag <Owner> object inside it. This <Owner> tag would be contain standard <Customer> object data (this fact would be documented in the fields list/documentation).

<CreditAccount>
	<Owner>
		... customer data ...
	</Owner>
</CreditAccount>

One To Many

These are wrapped in a tag that describes the collection's relationship to the parent object. For example <Category> could have a <ChildCategories> tag which contains a list of more <Category>s. The fields documentation will list information about types.

<Category>
	<ChildCategories>
		<Category>
			... category data ...
		</Category>
		<Category>
			... category data ...
		</Category>
	</ChildCategories>
</Category>

Attributes

readonly

Specifies that the field can only be read, and not written to. If you try to set a value on a read only field it will be ignored or an error will be thrown.

uri

Specifies the URI for the record linked to by the foreign key. You can use the URI to retrieve the related record.