Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Parameters:

type (Mandatory)

Must be either empty, "DESC" or "URL".

value (Mandatory)

Must be either empty, contain brief descriptive text (type=DESC) or a URL (type=URL).

index (Optional)

A numeric value indicating the index at which to store the value.

Description:

Responsible for the creation of a handle. If type and value are both empty a handle with no values is created. The handle is assigned an assigned an HS_ADMIN value at  value at index 100 representing the  representing the handle server administrator and an and an AGENTID value at  value at index 101 containing the  containing the handle of the owner of the newly created handle. If the owner is not known to the handle system, an owner is created from the identifier and authDomain values from the request and assigned a handle. This owner handle is also treated the same as a newly minted handle with the addition of a non-publicly readable DESC value at index 102 describing the owner.publicly readable DESC value at index 102 describing the owner.

Service Type:

POST

Parameters:

type (Mandatory)

Must be either empty, "DESC" or "URL".

value (Mandatory)

Must be either empty, contain brief descriptive text (type=DESC) or a URL (type=URL).

index (Optional)

A numeric value indicating the index at which to store the value.

Example Request:

URL

https://handle.ands.org.au/pids/mint?type=DESC&value=ANDS Home Page

POST Body

Code Block
languagexml
<?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:

Code Block
languagexml
<response type="success">
    <identifier handle="10378.2/12">
        <property index="1" type="URLDESC" value="http://ands.org.auANDS Home Page" />
    </identifier>
    <timestamp>2009-05-15T01:41:11Z</timestamp>
    <message type="user">Successfully authenticated and created handle</message>
</response>