Differences between revisions 1 and 13 (spanning 12 versions)
⇤ ← Revision 1 as of 2008-06-26 12:26:10 →
Size: 470
Editor: kfc
Comment: Created by the PackagePages action.
← Revision 13 as of 2010-03-17 13:08:50 → ⇥
Size: 832
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= PID API here = = PID API =
Line 3: Line 3:
A webservice for generating a PID will be provided. A webservice for generating a PID is provided.
Line 5: Line 5:
The API will be trivially simple: A call to the given method will give the next available API. Optionally, a prefix may be given that should be part of the PID. The API is trivially simple: A call to the given method will give the next available API. Optionally, a string may be given that should be part of the PID.
Line 9: Line 9:
Implementation note: Due to a length restriction of 64 characters for Fedora PIDs, any prefix longer than approx 50 characters will be shortened, to ensure space for adding a unique part to the PID. Implementation note: Due to a length restriction of 64 characters for Fedora PIDs, any string longer than approx 50 characters will be shortened, to ensure space for adding a unique part to the PID.


== PID API ==

WSDL: [[attachment:DomsPIDGenerator.xml]]

The following describes those methods of the PID API that may be called by the GUI.

==== generateNexAvailablePID ====
Generates a new PID.

Input parameters:
 * {{{String infix}}} The PID of the object.

Returns:
 * {{{String}}} The newly generated unique PID, possibly including the provided infix.

PID API

A webservice for generating a PID is provided.

The API is trivially simple: A call to the given method will give the next available API. Optionally, a string may be given that should be part of the PID.

The call should never fail.

Implementation note: Due to a length restriction of 64 characters for Fedora PIDs, any string longer than approx 50 characters will be shortened, to ensure space for adding a unique part to the PID.

PID API

WSDL: DomsPIDGenerator.xml

The following describes those methods of the PID API that may be called by the GUI.

generateNexAvailablePID

Generates a new PID.

Input parameters:

  • String infix The PID of the object.

Returns:

  • String The newly generated unique PID, possibly including the provided infix.

PID API (last edited 2010-03-17 13:08:50 by localhost)