SCAX

Simple Content Administration Data Exchange
Specification Version 1.0


SCAX is a document format specification for the transfer of administration data to or from a SIMS service. An SCAX document may be in either XML or JSON syntax.

Each response must include scax as the first element with a version attribute indicating the specification version in the format #.#. See the SCAX XML Schema for a complete specification of the SCAX data structure.

If an SCAX document is saved to a filesystem, the recommended file name suffix is “*.scax”. Using “*.xml” in the case of XML format, or “*.json” in the case of JSON format, as the file name suffix is also acceptable.

SCAX XML Schema

SIMS Admin Data XML Schema

SIMS Metadata XML Schema

SIMS Ad Data XML Schema

Example SCAX document in XML:

<scax version="x.x" xmlns="http://simsapi.org">

    <accounts>
        <account>
            <first_name>John</first_name>
            <last_name>Doe</last_name>
            <email>john.doe@domain.com</email>
            <eid>W34DF</eid>
        </account>
        ...
    </accounts>

</scax>

Note: Defined values for each element are required to be understood. Additional vendor-specific values may be included using a “x_” prefix. Elements should have names in snake case (ie. “element_name” instead of “elementName”) and must not include a period (“.”) in the name. A basic implementation is not required to support vendor-specific values.