Addressing Object Properties

There are several URL Parameters where you will need to name specific properties of an object (like filter and fields). Generally speaking, see the endpoint's Response Attributes section for the properties that are available. Here are a few rules to keep in mind when constructing the property names.

• The name of a property on an object is addressed using dot notation like object.property. E.g. disciplines.grades

• JSON constructs in AB Connect responses that are inserted simply to adhere to JSON API requirements are not included in the property naming. E.g. if you want to address the standard_type of a standard object, the name is simply standard_type - not data.attributes.standard_type. Generally speaking, JSON API keywords can be left out of the names - things like attributes, relationships and data. Note that meta properties on relationships are the acception. We include the meta part of the property path to eliminate conflicts between object and relationship property names.