Service: modifyValueByIndex

Description:

Changes a value associated with an existing handle. Only the owner of the handle is able to modify a value and only types of DESC and URL are able to be modified. To obtain available indexes a call to the getHandle service will return all available values and their indexes.

Service Type:

POST

Parameters:

handle _(Mandatory)

The handle that is to have one of its values modified.

value _(Mandatory)

The new value.

index _(Mandatory)

The index of the value to modify.

Example Request:

URL

https://identifiers.ardc.edu.au/pids/modifyValueByIndex?handle=10378.2/1234&type=DESC&value=Changed Value&index=2

POST Body

XML

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<request name="mint">
    <properties>
        <property name="appId" value="exampleAppID"/>
        <property name="sharedSecret" value="exampleSharedSecret"/>
        <property name="identifier" value="ExampleUser"/>
        <property name="authDomain" value="ExampleAuthDomain"/>
    </properties>
</request>

Example response:

XML

<response type="success">
    <identifier handle="10378.2/12">
        <property index="1" type="URL" value="http://ardc.edu.au" />
        <property index="2" type="DESC" value="Changed Value" />
    </identifier>
    <timestamp>2009-05-15T02:23:01Z</timestamp>
    <message type="user">Successfully modified handle value</message>
</response>