Resources

path methods description
  • GET
Returns basic information about the URN REST-API.

Access: Unauthorized (public) access allowed.

  • /admins
  • GET POST
Administrative Accounts for system administrators.
  • /admins/login/{login}
  • DELETE GET PATCH
Administrative Accounts for system administrators.
  • /namespaces
  • GET POST
Namespaces that are managed by the URN-Service.
  • /namespaces/name/{name}
  • DELETE GET HEAD PATCH
Namespaces that are managed by the URN-Service.
  • /namespaces/name/{name}/urn-suggestion
  • GET
Returns a suggestion for a new URN in this namespace.

Access: Namespace owners only for their own namespaces.

  • /namespaces/name/{name}/urns
  • GET
Returns all registered URNs in a namespace. The result set can be filtered using the q parameter.

The result set is paged. The count and offset parameters can be used to navigate through the result list. Alternatively, the Link header contains URLs for browsing through the result list.

Access: Unauthorized (public) access allowed.

  • /namespaces/suggestion
  • GET
Returns a suggestion for a new namespace name.

Access: System administrators only.

  • /organisations
  • GET POST
Organisations and contacts who manage their URNs and URLs with the URN-Service.
  • /organisations/id/{id}
  • DELETE GET PATCH
Organisations and contacts who manage their URNs and URLs with the URN-Service.
  • /organisations/id/{id}/contacts
  • GET POST
Organisations and contacts who manage their URNs and URLs with the URN-Service.
  • /organisations/id/{id}/contacts/id/{contactId}
  • DELETE GET PATCH
Organisations and contacts who manage their URNs and URLs with the URN-Service.
  • /organisations/id/{id}/namespaces
  • GET
Returns the namespaces of an organisation.

Access: Unauthorized (public) access allowed.

  • /organisations/login/{login}
  • GET
Returns an organisation by its login name.

Access: Unauthorized (public) access allowed.

  • /policies/url
  • GET
Returns a list of all supported URL policies.

Access: Unauthorized (public) access allowed.

  • /policies/url/id/{id}
  • GET
Returns a URL policy by its id.

Access: Unauthorized (public) access allowed.

  • /policies/urn-naming
  • GET
Returns a list of all supported URN naming policies.

Access: Unauthorized (public) access allowed.

  • /policies/urn-naming/id/{id}
  • GET
Returns a URN naming policy by its id.

Access: Unauthorized (public) access allowed.

  • /urns
  • GET POST
URNs managed by the URN-Service.
  • /urns/urn/{urn}
  • DELETE GET HEAD PATCH
URNs managed by the URN-Service.
  • /urns/urn/{urn}/my-urls
  • GET PATCH
URNs managed by the URN-Service.
  • /urns/urn/{urn}/urls
  • GET POST
URNs managed by the URN-Service.
  • /urns/urn/{urn}/urls/base64/{url}
  • DELETE GET
URNs managed by the URN-Service.

Data Types

JSON

type description
Address Describes a postal address.
Admin Describes a user with administrative rights.
ApiInfo Describes the endpoints of the URN-Service API.
Collection Generic Collection of objects. Used by endpoints that return more than one entity.
Contact Describes a person who can be contacted at an organisation.
CreateAdminRequest Payload for POST /admins.

Contains the user details of an admin which will be created.

CreateContactRequest Payload for POST /organisations/id/{id}/contacts.

Contains the details of the new contact.

CreateNamespaceRequest Payload for POST /namespaces.

Contains the name of the new namespace and additional administrative information.

CreateOrganisationRequest Payload for POST /organisations.

Contains the details of the new organisation that is registered with the URN administration.

CreateUrlRequest Payload for POST /urns/urn/{urn}/urls.

Describes a URL that will be attached to a URN.

CreateUrnRequest Payload for POST /urns.

Contains a new URN and additional information required for registering a new URN.

Namespace Describes a namespace.
NamespaceSuggestion Return type of GET /namespaces/suggestion.

Contains a suggestion for a name of a new namespace.

Organisation Describes an organisation which is registered with the URN administration.
ReplaceUrlRequest Payload for PATCH /urns/urn/{urn}/my-urls.

Describes a URL that should be replaced.

UpdateAdminRequest Payload for PATCH /admins/login/{login}.

Contains values of an admin record that should be updated.

UpdateContactRequest Payload for PATCH /organisations/id/{id}/contacts/id/{contactId}.

Contains new contact details for a person registered as contact at an organisation.

UpdateNamespaceRequest Payload for PATCH /namespaces/name/{name}.

Contains the new values for the descriptive information of a namespace.

UpdateOrganisationRequest Payload for PATCH /organisations/id/{id}.

Contains the new values for updating an organisation.

UpdateUrnRequest Payload for PATCH /urns/urn/{urn}.

Contains the values which will be updated on the URN entry.

Url Describes an URL to which a URN can be resolved.
UrlPolicy Describes a policy which is enforced when registering URLs.
Urn Describes a URN.
UrnNamingPolicy Describes a validation policy which is enforced when registering new URNs.
UrnSuggestion Return type of GET /namespaces/name/{name}/urn-suggestion.

Contains suggestions for new URNs in the requested namespace.