Data Types

JSON

type description
Address Describes a postal address.
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.
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.

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.
Urn Describes a URN.
UrnSuggestion Return type of GET /namespaces/name/{name}/urn-suggestion.

Contains suggestions for new URNs in the requested namespace.