Electronic Service Argument
Have you noticed we've changed?
We have updated the navigation structure of ands.org.au. Much of the content remains unchanged however it should now be easier to find. Any questions, ask your Cient Liasion Officer or email web@ands.org.au.
MME Highly Commended
Congratulations to the team at the Museum Metadata Exchange and the Powerhouse Museum. More information
International Author ID systems should connect
The Knowledge Exchange, organiser of the Digital Author Identifiers Summit in London last March, has now produced a report and recommendations. More information
| ANDS Quick Links | |||||||
|
Meaning and purpose
The <arg> (argument) element describes the file names or data that are passed between computer programs for use as an input. This element is only used for describing machine-to-machine services.
Arguments can apply to the URI contained in the <value> element within electronic address. Three elements can be recorded to describe arguments:
- whether the argument is required,
- the type of argument, and
- how the argument should be used.
Required indicator
The <required> indicator records whether the argument is required (true) or optional (false).
This information answers the question: If the electronic address is for a service, are arguments required to use the service?
Arg Type
This describes the kind of values the argument contains. Types of values are:
- string: (service only) Indicates the value of an argument is a plain text string
- object: indicates the value of an argument is an object, most likely in serialised form
This information answers the question: If arguments are required to make use of the service, what kind of arguments are they?
Use
A description of how the argument is used by a service. Metadata values are:
- inline: (service only) indicates the argument forms part of the base URL
- keyValue: (service only) indicates the argument is passed using key=value pairings in the query component of a URL
This information answers the question: If arguments are required, how are they used by the service?
Research domain examples
Under development.
Use in Research Data Australia
Arguments are not displayed in Research Data Australia as they are intended for use in machine-to-machine services.
RIF-CS best practice guidelines
Arguments apply only to electronic services. Do not use for activity, collection or party objects in the ANDS Collections Registry.
RIF-CS examples
(illustrative only):
<value>http://services.ands.org.au/pids/mint</value>
<arg required="true" type="string" use="keyValue">type</arg>
<arg required="true" type="string" use="keyValue">value</arg>
<arg required="false" type="string" use="keyValue">index</arg>
| Date | Change history |
| April 2010 | Consultation draft |
| 26 October 2010 | First web publication |
Please send any feedback on this page to guides@ands.org.au
