Ecosystem Identifier Service REST API

1. Entitiy API

Endpoints for interacting with Entities

1.1. Retrieve All

1.1.1. Request

GET /entity?page=0&size=25&sort=desc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

1.1.2. Query Parameters

Parameter Description

Parameter	Description
`page`	The page of Entities to retrieve
`size`	The number of Entities per page
`sort`	The way the returned page should be sorted

page

The page of Entities to retrieve

size

The number of Entities per page

sort

The way the returned page should be sorted

1.1.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 1982

{
  "_embedded" : {
    "entity" : [ {
      "id" : "009163fe-c1f9-4d3c-9c9f-edba2da32571",
      "url" : "http://www.example.com/1",
      "canonicalName" : "Example 1",
      "notes" : "Example 1 notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/entity/009163fe-c1f9-4d3c-9c9f-edba2da32571"
        },
        "entity" : {
          "href" : "http://localhost:8080/entity/009163fe-c1f9-4d3c-9c9f-edba2da32571"
        },
        "redirect" : {
          "href" : "http://localhost:8080/entity/009163fe-c1f9-4d3c-9c9f-edba2da32571/redirect"
        },
        "redirectByHead" : {
          "href" : "http://localhost:8080/entity/009163fe-c1f9-4d3c-9c9f-edba2da32571",
          "type" : "HEAD"
        }
      }
    }, {
      "id" : "c950c11d-cb9f-4c04-bccd-4ac62fda011c",
      "url" : "http://www.example.com/2",
      "canonicalName" : "Example 2",
      "notes" : "Example 2 notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/entity/c950c11d-cb9f-4c04-bccd-4ac62fda011c"
        },
        "entity" : {
          "href" : "http://localhost:8080/entity/c950c11d-cb9f-4c04-bccd-4ac62fda011c"
        },
        "redirect" : {
          "href" : "http://localhost:8080/entity/c950c11d-cb9f-4c04-bccd-4ac62fda011c/redirect"
        },
        "redirectByHead" : {
          "href" : "http://localhost:8080/entity/c950c11d-cb9f-4c04-bccd-4ac62fda011c",
          "type" : "HEAD"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity"
    },
    "profile" : {
      "href" : "http://localhost:8080/profile/entity"
    },
    "findByName" : {
      "href" : "http://localhost:8080/entity/name?name={name}",
      "templated" : true
    },
    "findByUrl" : {
      "href" : "http://localhost:8080/entity/url?url={url}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 25,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

1.1.4. Response Fields

Path Type Description

Path	Type	Description
`_embedded`	`Object`	A list of the Entities on the page
`_links`	`Object`	A list of links associated with the Enttiy collection
`page`	`Object`	A description of the attributes of the page

_embedded

Object

A list of the Entities on the page

_links

Object

A list of links associated with the Enttiy collection

page

Object

A description of the attributes of the page

1.1.5. Links

Relation Description

Relation	Description
`self`	A link to the Entity collection
`profile`	A link to the profile for the Entity collection
`findByUrl`	Returns the Entity that either contains the given URL, or is associated with the Identifier that does
`findByName`	Returns a list of Entities associated with a Name that matches the given value

self

A link to the Entity collection

profile

A link to the profile for the Entity collection

findByUrl

Returns the Entity that either contains the given URL, or is associated with the Identifier that does

findByName

Returns a list of Entities associated with a Name that matches the given value

1.2. Retrieve

1.2.1. Request

GET /entity/4980ee08-cf8a-466d-b98a-890653c76b64 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

1.2.2. Path Parameters

Table 1. /entity/{id}
Parameter	Description
`id`	The UUID id of the Entity to be retrieved

1.2.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 640

{
  "id" : "4980ee08-cf8a-466d-b98a-890653c76b64",
  "url" : "http://www.example.com/1",
  "canonicalName" : "Example 1",
  "notes" : "Example 1 notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity/4980ee08-cf8a-466d-b98a-890653c76b64"
    },
    "entity" : {
      "href" : "http://localhost:8080/entity/4980ee08-cf8a-466d-b98a-890653c76b64"
    },
    "redirect" : {
      "href" : "http://localhost:8080/entity/4980ee08-cf8a-466d-b98a-890653c76b64/redirect"
    },
    "redirectByHead" : {
      "href" : "http://localhost:8080/entity/4980ee08-cf8a-466d-b98a-890653c76b64",
      "type" : "HEAD"
    }
  }
}

1.2.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Entity
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity
`_links`	`Object`	A list of links associated with the Entity

id

String

The UUID id of the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

_links

Object

A list of links associated with the Entity

1.2.5. Links

Relation Description

Relation	Description
`self`	The canonical url for this Entity
`entity`	A link to the Entity resource
`redirect`	Redirects request to the URL associated with the Entity
`redirectByHead`	Redirects HEAD requests to the URL associated with the Entity

self

The canonical url for this Entity

entity

A link to the Entity resource

redirect

Redirects request to the URL associated with the Entity

redirectByHead

Redirects HEAD requests to the URL associated with the Entity

1.3. Create

1.3.1. Request

POST /entity HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 88
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"url":"http://www.example.com/1","canonicalName":"Example 1","notes":"Example 1 notes"}

1.3.2. Request Fields

Path Type Description

Path	Type	Description
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

1.3.3. Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/entity/2d61ba17-b42f-4983-950d-54c179bc1eb7
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 640

{
  "id" : "2d61ba17-b42f-4983-950d-54c179bc1eb7",
  "url" : "http://www.example.com/1",
  "canonicalName" : "Example 1",
  "notes" : "Example 1 notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity/2d61ba17-b42f-4983-950d-54c179bc1eb7"
    },
    "entity" : {
      "href" : "http://localhost:8080/entity/2d61ba17-b42f-4983-950d-54c179bc1eb7"
    },
    "redirect" : {
      "href" : "http://localhost:8080/entity/2d61ba17-b42f-4983-950d-54c179bc1eb7/redirect"
    },
    "redirectByHead" : {
      "href" : "http://localhost:8080/entity/2d61ba17-b42f-4983-950d-54c179bc1eb7",
      "type" : "HEAD"
    }
  }
}

1.3.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Entity
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity
`_links`	`Object`	A list of links associated with the Entity

id

String

The UUID id of the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

_links

Object

A list of links associated with the Entity

1.3.5. Links

Relation Description

Relation	Description
`self`	The canonical url for this Entity
`entity`	A link to the Entity resource
`redirect`	Redirects request to the URL associated with the Entity
`redirectByHead`	Redirects HEAD requests to the URL associated with the Entity

self

The canonical url for this Entity

entity

A link to the Entity resource

redirect

Redirects request to the URL associated with the Entity

redirectByHead

Redirects HEAD requests to the URL associated with the Entity

1.4. Replace

1.4.1. Request

PUT /entity/f8542ffa-6caf-4284-aecc-06d86f498869 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 88
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"url":"http://www.example.com/2","canonicalName":"Example 2","notes":"Example 2 notes"}

1.4.2. Path Parameters

Table 2. /entity/{id}
Parameter	Description
`id`	The UUID id of the Entity to be replaced

1.4.3. Request Fields

Path Type Description

Path	Type	Description
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

1.4.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/entity/f8542ffa-6caf-4284-aecc-06d86f498869
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 640

{
  "id" : "f8542ffa-6caf-4284-aecc-06d86f498869",
  "url" : "http://www.example.com/2",
  "canonicalName" : "Example 2",
  "notes" : "Example 2 notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity/f8542ffa-6caf-4284-aecc-06d86f498869"
    },
    "entity" : {
      "href" : "http://localhost:8080/entity/f8542ffa-6caf-4284-aecc-06d86f498869"
    },
    "redirect" : {
      "href" : "http://localhost:8080/entity/f8542ffa-6caf-4284-aecc-06d86f498869/redirect"
    },
    "redirectByHead" : {
      "href" : "http://localhost:8080/entity/f8542ffa-6caf-4284-aecc-06d86f498869",
      "type" : "HEAD"
    }
  }
}

1.4.5. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Entity
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity
`_links`	`Object`	A list of links associated with the Entity

id

String

The UUID id of the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

_links

Object

A list of links associated with the Entity

1.4.6. Links

Relation Description

Relation	Description
`self`	The canonical url for this Entity
`entity`	A link to the Entity resource
`redirect`	Redirects request to the URL associated with the Entity
`redirectByHead`	Redirects HEAD requests to the URL associated with the Entity

self

The canonical url for this Entity

entity

A link to the Entity resource

redirect

Redirects request to the URL associated with the Entity

redirectByHead

Redirects HEAD requests to the URL associated with the Entity

1.5. Update

1.5.1. Request

PATCH /entity/d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 88
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"url":"http://www.example.com/2","canonicalName":"Example 2","notes":"Example 2 notes"}

1.5.2. Path Parameters

Table 3. /entity/{id}
Parameter	Description
`id`	The UUID id of the Entity to be replaced

1.5.3. Request Fields

Path Type Description

Path	Type	Description
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

1.5.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 640

{
  "id" : "d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e",
  "url" : "http://www.example.com/2",
  "canonicalName" : "Example 2",
  "notes" : "Example 2 notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity/d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e"
    },
    "entity" : {
      "href" : "http://localhost:8080/entity/d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e"
    },
    "redirect" : {
      "href" : "http://localhost:8080/entity/d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e/redirect"
    },
    "redirectByHead" : {
      "href" : "http://localhost:8080/entity/d7ee284c-6f81-4a2c-9c8c-b5ecac795d0e",
      "type" : "HEAD"
    }
  }
}

1.5.5. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Entity
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity
`_links`	`Object`	A list of links associated with the Entity

id

String

The UUID id of the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

_links

Object

A list of links associated with the Entity

1.5.6. Links

Relation Description

Relation	Description
`self`	The canonical url for this Entity
`entity`	A link to the Entity resource
`redirect`	Redirects request to the URL associated with the Entity
`redirectByHead`	Redirects HEAD requests to the URL associated with the Entity

self

The canonical url for this Entity

entity

A link to the Entity resource

redirect

Redirects request to the URL associated with the Entity

redirectByHead

Redirects HEAD requests to the URL associated with the Entity

1.6. Delete

1.6.1. Request

DELETE /entity/84846765-bf59-4e90-a94f-77f94c6bf1a8 HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

1.6.2. Path Parameters

Table 4. /entity/{id}
Parameter	Description
`id`	The UUID id of the Entity to be replaced

1.6.3. Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN

1.7. Redirect HEAD Request

1.7.1. Request

HEAD /entity/d01db28c-660f-4b1e-971f-c5a9b37d80e3 HTTP/1.1
Host: localhost:8080

1.7.2. Path Parameters

Table 5. /entity/{id}
Parameter	Description
`id`	The UUID id of the Entity whose URL the response will redirect to

1.7.3. Response

HTTP/1.1 302 Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Language: en
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Location: http://www.example.com/1

1.8. Redirect GET Request

1.8.1. Request

GET /entity/5b1ebda5-d670-462d-b4b7-4bcddf6414c5/redirect HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: localhost:8080

1.8.2. Path Parameters

Table 6. /entity/{id}/redirect
Parameter	Description
`id`	The UUID id of the Entity whose URL the response will redirect to

1.8.3. Response

HTTP/1.1 302 Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Language: en
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Location: http://www.example.com/1

1.9. Find Entity By URL

1.9.1. Request

GET /entity/url?url=http%3A%2F%2Fwww.example.com%2F1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

1.9.2. Query Parameters

Parameter Description

Parameter	Description
`url`	The URL on the desired Entity, or on an associated Identifier

url

The URL on the desired Entity, or on an associated Identifier

1.9.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 640

{
  "id" : "e38c174f-84a5-4e6e-98d1-c78fe4d303b2",
  "url" : "http://www.example.com/1",
  "canonicalName" : "Example 1",
  "notes" : "Example 1 notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/entity/e38c174f-84a5-4e6e-98d1-c78fe4d303b2"
    },
    "entity" : {
      "href" : "http://localhost:8080/entity/e38c174f-84a5-4e6e-98d1-c78fe4d303b2"
    },
    "redirect" : {
      "href" : "http://localhost:8080/entity/e38c174f-84a5-4e6e-98d1-c78fe4d303b2/redirect"
    },
    "redirectByHead" : {
      "href" : "http://localhost:8080/entity/e38c174f-84a5-4e6e-98d1-c78fe4d303b2",
      "type" : "HEAD"
    }
  }
}

1.9.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Entity
`url`	`String`	The URL of the Entity
`canonicalName`	`String`	The canonical name for the Entity
`notes`	`String`	Notes describing the Entity
`_links`	`Object`	A list of links associated with the Entity

id

String

The UUID id of the Entity

url

String

The URL of the Entity

canonicalName

String

The canonical name for the Entity

notes

String

Notes describing the Entity

_links

Object

A list of links associated with the Entity

1.9.5. Links

Relation Description

Relation	Description
`self`	The canonical url for this Entity
`entity`	A link to the Entity resource
`redirect`	Redirects request to the URL associated with the Entity
`redirectByHead`	Redirects HEAD requests to the URL associated with the Entity

self

The canonical url for this Entity

entity

A link to the Entity resource

redirect

Redirects request to the URL associated with the Entity

redirectByHead

Redirects HEAD requests to the URL associated with the Entity

1.10. Find Entities By Name

1.10.1. Request

GET /entity/name?name=Name HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

1.10.2. Query Parameters

Parameter Description

Parameter	Description
`name`	Name value to find associated Entities by

name

Name value to find associated Entities by

1.10.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 1487

{
  "_embedded" : {
    "entity" : [ {
      "id" : "b43b4730-8221-43c7-8259-13739daee545",
      "url" : "http://www.example.com/2",
      "canonicalName" : "Example 2",
      "notes" : "Example 2 notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/entity/b43b4730-8221-43c7-8259-13739daee545"
        },
        "entity" : {
          "href" : "http://localhost:8080/entity/b43b4730-8221-43c7-8259-13739daee545"
        },
        "redirect" : {
          "href" : "http://localhost:8080/entity/b43b4730-8221-43c7-8259-13739daee545/redirect"
        },
        "redirectByHead" : {
          "href" : "http://localhost:8080/entity/b43b4730-8221-43c7-8259-13739daee545",
          "type" : "HEAD"
        }
      }
    }, {
      "id" : "96fddc52-75bc-42aa-90f5-6da845eb2819",
      "url" : "http://www.example.com/1",
      "canonicalName" : "Example 1",
      "notes" : "Example 1 notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/entity/96fddc52-75bc-42aa-90f5-6da845eb2819"
        },
        "entity" : {
          "href" : "http://localhost:8080/entity/96fddc52-75bc-42aa-90f5-6da845eb2819"
        },
        "redirect" : {
          "href" : "http://localhost:8080/entity/96fddc52-75bc-42aa-90f5-6da845eb2819/redirect"
        },
        "redirectByHead" : {
          "href" : "http://localhost:8080/entity/96fddc52-75bc-42aa-90f5-6da845eb2819",
          "type" : "HEAD"
        }
      }
    } ]
  }
}

1.10.4. Response Fields

Path Type Description

Path	Type	Description
`_embedded`	`Object`	HAL wrapper indicating results are full enitities
`_embedded.entity`	`Array`	A set of all matching Entities

_embedded

Object

HAL wrapper indicating results are full enitities

_embedded.entity

Array

A set of all matching Entities

2. Identifier API

Endpoints for interacting with Identifiers

2.1. Retrieve All

2.1.1. Request

GET /identifier?page=0&size=25&sort=desc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080

2.1.2. Query Parameters

Parameter Description

Parameter	Description
`page`	The page of Identifiers to retrieve
`size`	The number of Identifiers per page
`sort`	The way the returned page should be sorted

page

The page of Identifiers to retrieve

size

The number of Identifiers per page

sort

The way the returned page should be sorted

2.1.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 1850

{
  "_embedded" : {
    "identifier" : [ {
      "id" : "2f0421a0-7595-4230-abb9-bcfbef9c9cf1",
      "identifier" : "http://www.example.com/2",
      "startDate" : "2020-01-01",
      "endDate" : "2020-04-15",
      "notes" : "Identifier 1 Notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/identifier/2f0421a0-7595-4230-abb9-bcfbef9c9cf1"
        },
        "identifier" : {
          "href" : "http://localhost:8080/identifier/2f0421a0-7595-4230-abb9-bcfbef9c9cf1"
        },
        "identifierType" : {
          "href" : "http://localhost:8080/identifier/2f0421a0-7595-4230-abb9-bcfbef9c9cf1/identifierType"
        },
        "entity" : {
          "href" : "http://localhost:8080/identifier/2f0421a0-7595-4230-abb9-bcfbef9c9cf1/entity"
        }
      }
    }, {
      "id" : "62116527-113c-46e2-b21d-7e13a8472e17",
      "identifier" : "http://www.example.com/3",
      "startDate" : "1990-02-04",
      "endDate" : "2010-09-01",
      "notes" : "Identifier 2 Notes",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/identifier/62116527-113c-46e2-b21d-7e13a8472e17"
        },
        "identifier" : {
          "href" : "http://localhost:8080/identifier/62116527-113c-46e2-b21d-7e13a8472e17"
        },
        "identifierType" : {
          "href" : "http://localhost:8080/identifier/62116527-113c-46e2-b21d-7e13a8472e17/identifierType"
        },
        "entity" : {
          "href" : "http://localhost:8080/identifier/62116527-113c-46e2-b21d-7e13a8472e17/entity"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifier"
    },
    "profile" : {
      "href" : "http://localhost:8080/profile/identifier"
    }
  },
  "page" : {
    "size" : 25,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

2.1.4. Response Fields

Path Type Description

Path	Type	Description
`_embedded`	`Object`	A list of the Identifiers on the page
`_links`	`Object`	A list of links associated with the Identifier collection
`page`	`Object`	A description of the attributes of the page

_embedded

Object

A list of the Identifiers on the page

_links

Object

A list of links associated with the Identifier collection

page

Object

A description of the attributes of the page

2.1.5. Links

Relation Description

Relation	Description
`self`	The canonical URL for this Identifier
`profile`	A link to the Identifier resource

self

The canonical URL for this Identifier

profile

A link to the Identifier resource

2.2. Retrieve

2.2.1. Request

GET /identifier/26305823-6276-460b-b7ce-567b933d256e HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

2.2.2. Path Parameters

Table 7. /identifier/{id}
Parameter	Description
`id`	The UUID id of the Identifer to be retrieved

2.2.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 683

{
  "id" : "26305823-6276-460b-b7ce-567b933d256e",
  "identifier" : "http://www.example.com/2",
  "startDate" : "2020-01-01",
  "endDate" : "2020-04-15",
  "notes" : "Identifier 1 Notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifier/26305823-6276-460b-b7ce-567b933d256e"
    },
    "identifier" : {
      "href" : "http://localhost:8080/identifier/26305823-6276-460b-b7ce-567b933d256e"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifier/26305823-6276-460b-b7ce-567b933d256e/identifierType"
    },
    "entity" : {
      "href" : "http://localhost:8080/identifier/26305823-6276-460b-b7ce-567b933d256e/entity"
    }
  }
}

2.2.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Identifier
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`_links`	`Object`	A list of links associated with the Identifier

id

String

The UUID id of the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

_links

Object

A list of links associated with the Identifier

2.2.5. Links

Relation Description

Relation	Description
`self`	The canoncial url for this Identifier
`identifier`	A link to the Identifier resource
`entity`	A link to the Entity associated with this Identifier
`identifierType`	A link to the IdentifierType associated with this Identifier

self

The canoncial url for this Identifier

identifier

A link to the Identifier resource

entity

A link to the Entity associated with this Identifier

identifierType

A link to the IdentifierType associated with this Identifier

2.3. Create

2.3.1. Request

POST /identifier HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 256
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"identifier":"http://www.example.com/2","notes":"Identifier 1 Notes","endDate":"2020-04-15","identifierType":"http://localhost/bfffa7dd-0801-4aa3-8340-0105496c4859","startDate":"2020-01-01","entity":"http://localhost/fff17355-318e-4515-8cd0-50d32528ff5a"}

2.3.2. Request Fields

Path Type Description

Path	Type	Description
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`identifierType`	`String`	The IdentifierType associated with the Identifier
`entity`	`String`	The Entity associated with the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

identifierType

String

The IdentifierType associated with the Identifier

entity

String

The Entity associated with the Identifier

2.3.3. Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/identifier/16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 683

{
  "id" : "16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f",
  "identifier" : "http://www.example.com/2",
  "startDate" : "2020-01-01",
  "endDate" : "2020-04-15",
  "notes" : "Identifier 1 Notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifier/16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f"
    },
    "identifier" : {
      "href" : "http://localhost:8080/identifier/16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifier/16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f/identifierType"
    },
    "entity" : {
      "href" : "http://localhost:8080/identifier/16eaf9dd-5ee3-4c84-bf17-c9e6c79e186f/entity"
    }
  }
}

2.3.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Identifier
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`_links`	`Object`	A list of links associated with the Identifier

id

String

The UUID id of the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

_links

Object

A list of links associated with the Identifier

2.3.5. Links

Relation Description

Relation	Description
`self`	The canoncial url for this Identifier
`identifier`	A link to the Identifier resource
`entity`	A link to the Entity associated with this Identifier
`identifierType`	A link to the IdentifierType associated with this Identifier

self

The canoncial url for this Identifier

identifier

A link to the Identifier resource

entity

A link to the Entity associated with this Identifier

identifierType

A link to the IdentifierType associated with this Identifier

2.4. Replace

2.4.1. Request

PUT /identifier/d85c3459-f850-4cca-991f-97b4a7591fd3 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 256
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"identifier":"http://www.example.com/3","notes":"Identifier 2 Notes","endDate":"2010-09-01","identifierType":"http://localhost/f1d1da27-149b-4497-a271-fcd6a678489f","startDate":"1990-02-04","entity":"http://localhost/8ea6dc2a-e39e-4fab-803c-f92a45f1a048"}

2.4.2. Path Parameters

Table 8. /identifier/{id}
Parameter	Description
`id`	The UUID id of the Identifier to be replaced

2.4.3. Request Fields

Path Type Description

Path	Type	Description
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`identifierType`	`String`	The IdentifierType associated with the Identifier
`entity`	`String`	The Entity associated with the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

identifierType

String

The IdentifierType associated with the Identifier

entity

String

The Entity associated with the Identifier

2.4.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/identifier/d85c3459-f850-4cca-991f-97b4a7591fd3
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 683

{
  "id" : "d85c3459-f850-4cca-991f-97b4a7591fd3",
  "identifier" : "http://www.example.com/3",
  "startDate" : "1990-02-04",
  "endDate" : "2010-09-01",
  "notes" : "Identifier 2 Notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifier/d85c3459-f850-4cca-991f-97b4a7591fd3"
    },
    "identifier" : {
      "href" : "http://localhost:8080/identifier/d85c3459-f850-4cca-991f-97b4a7591fd3"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifier/d85c3459-f850-4cca-991f-97b4a7591fd3/identifierType"
    },
    "entity" : {
      "href" : "http://localhost:8080/identifier/d85c3459-f850-4cca-991f-97b4a7591fd3/entity"
    }
  }
}

2.4.5. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Identifier
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`_links`	`Object`	A list of links associated with the Identifier

id

String

The UUID id of the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

_links

Object

A list of links associated with the Identifier

2.4.6. Links

Relation Description

Relation	Description
`self`	The canoncial url for this Identifier
`identifier`	A link to the Identifier resource
`entity`	A link to the Entity associated with this Identifier
`identifierType`	A link to the IdentifierType associated with this Identifier

self

The canoncial url for this Identifier

identifier

A link to the Identifier resource

entity

A link to the Entity associated with this Identifier

identifierType

A link to the IdentifierType associated with this Identifier

2.5. Update

2.5.1. Request

PATCH /identifier/c9ec8bf6-ba94-4f54-8738-ac8e617331eb HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 256
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"identifier":"http://www.example.com/3","notes":"Identifier 2 Notes","endDate":"2010-09-01","identifierType":"http://localhost/7d5a53b1-89cf-473b-be1e-429f1e052430","startDate":"1990-02-04","entity":"http://localhost/dac716ac-6c18-4f7a-b4c5-967d6445fd4d"}

2.5.2. Path Parameters

Table 9. /identifier/{id}
Parameter	Description
`id`	The UUID id of the Identifier to be replaced

2.5.3. Request Fields

Path Type Description

Path	Type	Description
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`identifierType`	`String`	The IdentifierType associated with the Identifier
`entity`	`String`	The Entity associated with the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

identifierType

String

The IdentifierType associated with the Identifier

entity

String

The Entity associated with the Identifier

2.5.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 683

{
  "id" : "c9ec8bf6-ba94-4f54-8738-ac8e617331eb",
  "identifier" : "http://www.example.com/3",
  "startDate" : "1990-02-04",
  "endDate" : "2010-09-01",
  "notes" : "Identifier 2 Notes",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifier/c9ec8bf6-ba94-4f54-8738-ac8e617331eb"
    },
    "identifier" : {
      "href" : "http://localhost:8080/identifier/c9ec8bf6-ba94-4f54-8738-ac8e617331eb"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifier/c9ec8bf6-ba94-4f54-8738-ac8e617331eb/identifierType"
    },
    "entity" : {
      "href" : "http://localhost:8080/identifier/c9ec8bf6-ba94-4f54-8738-ac8e617331eb/entity"
    }
  }
}

2.5.5. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Identifier
`notes`	`String`	The notes used to describe the Identifier
`identifier`	`String`	The identifier property of the Identifier entity
`startDate`	`String`	The date the Identifier became active
`endDate`	`String`	The date the Identifier became inactive
`_links`	`Object`	A list of links associated with the Identifier

id

String

The UUID id of the Identifier

notes

String

The notes used to describe the Identifier

identifier

String

The identifier property of the Identifier entity

startDate

String

The date the Identifier became active

endDate

String

The date the Identifier became inactive

_links

Object

A list of links associated with the Identifier

2.5.6. Links

Relation Description

Relation	Description
`self`	The canoncial url for this Identifier
`identifier`	A link to the Identifier resource
`entity`	A link to the Entity associated with this Identifier
`identifierType`	A link to the IdentifierType associated with this Identifier

self

The canoncial url for this Identifier

identifier

A link to the Identifier resource

entity

A link to the Entity associated with this Identifier

identifierType

A link to the IdentifierType associated with this Identifier

2.6. Delete

2.6.1. Request

DELETE /identifier/fbeabfa3-bf6c-467f-a4a3-50cb1f73b929 HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

2.6.2. Path Parameters

Table 10. /identifier/{id}
Parameter	Description
`id`	The UUID id of the Identifier to delete

2.6.3. Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN

3. Identifier Type API

Endpoints for interacting with Identifier Types

3.1. Retrieve All

3.1.1. Request

GET /identifierType?page=0&size=25&sort=desc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080

3.1.2. Query Parameters

Parameter Description

Parameter	Description
`page`	The page of Identifier Types to retrieve
`size`	The number of Identifier Types per page
`sort`	The way the returned page should be sorted

page

The page of Identifier Types to retrieve

size

The number of Identifier Types per page

sort

The way the returned page should be sorted

3.1.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 1204

{
  "_embedded" : {
    "identifierType" : [ {
      "id" : "7583d046-8c26-4e04-b265-254fda1a8bce",
      "namespace" : "http://www.example1.com",
      "name" : "Test Identifier Type 1",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/identifierType/7583d046-8c26-4e04-b265-254fda1a8bce"
        },
        "identifierType" : {
          "href" : "http://localhost:8080/identifierType/7583d046-8c26-4e04-b265-254fda1a8bce"
        }
      }
    }, {
      "id" : "8b8dbf4e-f90b-494e-853e-8b8acb03a8ce",
      "namespace" : "http://www.example2.com",
      "name" : "Test Identifier Type 1",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/identifierType/8b8dbf4e-f90b-494e-853e-8b8acb03a8ce"
        },
        "identifierType" : {
          "href" : "http://localhost:8080/identifierType/8b8dbf4e-f90b-494e-853e-8b8acb03a8ce"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifierType"
    },
    "profile" : {
      "href" : "http://localhost:8080/profile/identifierType"
    }
  },
  "page" : {
    "size" : 25,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

3.1.4. Response Fields

Path Type Description

Path	Type	Description
`_embedded`	`Object`	A list of the Identifier Types on the page
`_links`	`Object`	A list of links associated with the Identifier Type collection
`page`	`Object`	A description of the attributes of the page

_embedded

Object

A list of the Identifier Types on the page

_links

Object

A list of links associated with the Identifier Type collection

page

Object

A description of the attributes of the page

3.1.5. Links

Relation Description

Relation	Description
`self`	The canonical URL for this Identifier Type
`profile`	A link to the Identifier Type resource

self

The canonical URL for this Identifier Type

profile

A link to the Identifier Type resource

3.2. Retrieve

3.2.1. Request

GET /identifierType/660dc22c-fc44-4e48-9844-04d9391896fb HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

3.2.2. Path Parameters

Table 11. /identifierType/{id}
Parameter	Description
`id`	The UUID id of the Identifier Type to be retrieved

3.2.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 386

{
  "id" : "660dc22c-fc44-4e48-9844-04d9391896fb",
  "namespace" : "http://www.example1.com",
  "name" : "Test Identifier Type 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifierType/660dc22c-fc44-4e48-9844-04d9391896fb"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifierType/660dc22c-fc44-4e48-9844-04d9391896fb"
    }
  }
}

3.2.4. Response Fields

Path Type Description

Path	Type	Description
`id`	`String`	The UUID id of the Identifier Type
`name`	`String`	The name of the Identifier Type
`namespace`	`String`	The namespace associated with the Identifier Type
`_links`	`Object`	A list of links associated with the Identifier Type

id

String

The UUID id of the Identifier Type

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

_links

Object

A list of links associated with the Identifier Type

3.2.5. Links

Relation Description

Relation	Description
`self`	The canoncial url for this Identifier Type
`identifierType`	A link to the Identifier Type resource

self

The canoncial url for this Identifier Type

identifierType

A link to the Identifier Type resource

3.3. Create

3.3.1. Request

POST /identifierType HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 71
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"namespace":"http://www.example1.com","name":"Test Identifier Type 1"}

3.3.2. Request Fields

Path Type Description

Path	Type	Description
`name`	`String`	The name of the Identifier Type
`namespace`	`String`	The namespace associated with the Identifier Type

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

3.3.3. Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/identifierType/c68f9dfd-4fa6-4881-bba4-5b2945878146
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 386

{
  "id" : "c68f9dfd-4fa6-4881-bba4-5b2945878146",
  "namespace" : "http://www.example1.com",
  "name" : "Test Identifier Type 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifierType/c68f9dfd-4fa6-4881-bba4-5b2945878146"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifierType/c68f9dfd-4fa6-4881-bba4-5b2945878146"
    }
  }
}

3.3.4. Response Fields

Path Type Description

id

String

The UUID id of the Identifier Type

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

_links

Object

A list of links associated with the Identifier Type

3.3.5. Links

Relation Description

self

The canoncial url for this Identifier Type

identifierType

A link to the Identifier Type resource

3.4. Replace

3.4.1. Request

PUT /identifierType/a8e6b599-03ef-4194-baa8-e2415e855d99 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 71
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"namespace":"http://www.example2.com","name":"Test Identifier Type 1"}

3.4.2. Path Parameters

Table 12. /identifierType/{id}
Parameter	Description
`id`	The UUID id of the Identifier to be replaced

3.4.3. Request Fields

Path Type Description

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

3.4.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/identifierType/a8e6b599-03ef-4194-baa8-e2415e855d99
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 386

{
  "id" : "a8e6b599-03ef-4194-baa8-e2415e855d99",
  "namespace" : "http://www.example2.com",
  "name" : "Test Identifier Type 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifierType/a8e6b599-03ef-4194-baa8-e2415e855d99"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifierType/a8e6b599-03ef-4194-baa8-e2415e855d99"
    }
  }
}

3.4.5. Response Fields

Path Type Description

id

String

The UUID id of the Identifier Type

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

_links

Object

A list of links associated with the Identifier Type

3.4.6. Links

Relation Description

self

The canoncial url for this Identifier Type

identifierType

A link to the Identifier Type resource

3.5. Update

3.5.1. Request

PATCH /identifierType/455a5ba5-7670-4265-86b6-df27ca60eb4d HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 71
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"namespace":"http://www.example2.com","name":"Test Identifier Type 1"}

3.5.2. Path Parameters

Table 13. /identifierType/{id}
Parameter	Description
`id`	The UUID id of the Identifier to be updated

3.5.3. Request Fields

Path Type Description

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

3.5.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 386

{
  "id" : "455a5ba5-7670-4265-86b6-df27ca60eb4d",
  "namespace" : "http://www.example2.com",
  "name" : "Test Identifier Type 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/identifierType/455a5ba5-7670-4265-86b6-df27ca60eb4d"
    },
    "identifierType" : {
      "href" : "http://localhost:8080/identifierType/455a5ba5-7670-4265-86b6-df27ca60eb4d"
    }
  }
}

3.5.5. Response Fields

Path Type Description

id

String

The UUID id of the Identifier Type

name

String

The name of the Identifier Type

namespace

String

The namespace associated with the Identifier Type

_links

Object

A list of links associated with the Identifier Type

3.5.6. Links

Relation Description

self

The canoncial url for this Identifier Type

identifierType

A link to the Identifier Type resource

3.6. Delete

3.6.1. Request

DELETE /identifierType/e297269e-2104-4a03-ac28-d0a8b08f3d2a HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

3.6.2. Path Parameters

Table 14. /identifierType/{id}
Parameter	Description
`id`	The UUID id of the Identifier Type to be deleted

3.6.3. Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN

4. Name API

Endpoints for interacting with Names

4.1. Retrieve All

4.1.1. Request

GET /name?page=0&size=25&sort=desc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080

4.1.2. Query Parameters

Parameter Description

page

The page of Names to retrieve

size

The number of Names per page

sort

The way the returned page should be sorted

4.1.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 1460

{
  "_embedded" : {
    "name" : [ {
      "id" : "32f9f3c9-c46f-489d-aaad-6a2c25c38bf8",
      "name" : "Test Name 1",
      "startDate" : "2020-01-01",
      "endDate" : "2020-04-15",
      "notes" : "Test Notes for Name 1",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/name/32f9f3c9-c46f-489d-aaad-6a2c25c38bf8"
        },
        "name" : {
          "href" : "http://localhost:8080/name/32f9f3c9-c46f-489d-aaad-6a2c25c38bf8"
        },
        "entity" : {
          "href" : "http://localhost:8080/name/32f9f3c9-c46f-489d-aaad-6a2c25c38bf8/entity"
        }
      }
    }, {
      "id" : "81c012f2-fb97-471a-ab1e-fb5c6c764b90",
      "name" : "Test Name 2",
      "startDate" : "1990-02-04",
      "endDate" : "2010-09-01",
      "notes" : "Test Notes for Name 2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/name/81c012f2-fb97-471a-ab1e-fb5c6c764b90"
        },
        "name" : {
          "href" : "http://localhost:8080/name/81c012f2-fb97-471a-ab1e-fb5c6c764b90"
        },
        "entity" : {
          "href" : "http://localhost:8080/name/81c012f2-fb97-471a-ab1e-fb5c6c764b90/entity"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/name"
    },
    "profile" : {
      "href" : "http://localhost:8080/profile/name"
    }
  },
  "page" : {
    "size" : 25,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

4.1.4. Response Fields

Path Type Description

_embedded

Object

A list of the Names on the page

_links

Object

A list of links associated with the Name collection

page

Object

A description of the attributes of the page

4.1.5. Links

Relation Description

self

The canonical URL for this Name

profile

A link to the Name resource

4.2. Retrieve

4.2.1. Request

GET /name/5e973f4f-2d9a-49f0-b98e-bc5d659b7e39 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Host: localhost:8080

4.2.2. Path Parameters

Table 15. /name/{id}
Parameter	Description
`id`	The UUID id of the Name to be retrieved

4.2.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 509

{
  "id" : "5e973f4f-2d9a-49f0-b98e-bc5d659b7e39",
  "name" : "Test Name 1",
  "startDate" : "2020-01-01",
  "endDate" : "2020-04-15",
  "notes" : "Test Notes for Name 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/name/5e973f4f-2d9a-49f0-b98e-bc5d659b7e39"
    },
    "name" : {
      "href" : "http://localhost:8080/name/5e973f4f-2d9a-49f0-b98e-bc5d659b7e39"
    },
    "entity" : {
      "href" : "http://localhost:8080/name/5e973f4f-2d9a-49f0-b98e-bc5d659b7e39/entity"
    }
  }
}

4.2.4. Response Fields

Path Type Description

id

String

The UUID id of the Name

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

_links

Object

A list of links associated with the Name

4.2.5. Links

Relation Description

self

The canoncial url for this Name

name

A link to the Name resource

entity

A link to the Entity associated with this Name

4.3. Create

4.3.1. Request

POST /name HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 167
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"notes":"Test Notes for Name 1","endDate":"2020-04-15","name":"Test Name 1","startDate":"2020-01-01","entity":"http://localhost/05a3f7bb-f83b-4ae9-8c4a-45708ad395eb"}

4.3.2. Request Fields

Path Type Description

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

entity

String

The Entity associated with the Name

4.3.3. Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/name/ff553b68-83f5-4d57-9fcd-af0c6258c897
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 509

{
  "id" : "ff553b68-83f5-4d57-9fcd-af0c6258c897",
  "name" : "Test Name 1",
  "startDate" : "2020-01-01",
  "endDate" : "2020-04-15",
  "notes" : "Test Notes for Name 1",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/name/ff553b68-83f5-4d57-9fcd-af0c6258c897"
    },
    "name" : {
      "href" : "http://localhost:8080/name/ff553b68-83f5-4d57-9fcd-af0c6258c897"
    },
    "entity" : {
      "href" : "http://localhost:8080/name/ff553b68-83f5-4d57-9fcd-af0c6258c897/entity"
    }
  }
}

4.3.4. Response Fields

Path Type Description

id

String

The UUID id of the Name

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

_links

Object

A list of links associated with the Name

4.3.5. Links

Relation Description

self

The canoncial url for this Name

name

A link to the Name resource

entity

A link to the Entity associated with this Name

4.4. Replace

4.4.1. Request

PUT /name/7bc395e4-dc45-4faa-8c53-d2ad1a0aba86 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 167
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"notes":"Test Notes for Name 2","endDate":"2010-09-01","name":"Test Name 2","startDate":"1990-02-04","entity":"http://localhost/ed4584ed-7e06-44f2-8cca-fb18085abb88"}

4.4.2. Path Parameters

Table 16. /name/{id}
Parameter	Description
`id`	The UUID id of the Name to be replaced

4.4.3. Request Fields

Path Type Description

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

entity

String

The Entity associated with the Name

4.4.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/name/7bc395e4-dc45-4faa-8c53-d2ad1a0aba86
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 509

{
  "id" : "7bc395e4-dc45-4faa-8c53-d2ad1a0aba86",
  "name" : "Test Name 2",
  "startDate" : "1990-02-04",
  "endDate" : "2010-09-01",
  "notes" : "Test Notes for Name 2",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/name/7bc395e4-dc45-4faa-8c53-d2ad1a0aba86"
    },
    "name" : {
      "href" : "http://localhost:8080/name/7bc395e4-dc45-4faa-8c53-d2ad1a0aba86"
    },
    "entity" : {
      "href" : "http://localhost:8080/name/7bc395e4-dc45-4faa-8c53-d2ad1a0aba86/entity"
    }
  }
}

4.4.5. Response Fields

Path Type Description

id

String

The UUID id of the Name

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

_links

Object

A list of links associated with the Name

4.4.6. Links

Relation Description

self

The canoncial url for this Name

name

A link to the Name resource

entity

A link to the Entity associated with this Name

4.5. Update

4.5.1. Request

PATCH /name/8e86459e-bd69-4219-9b17-afd417293b69 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/hal+json
Content-Length: 167
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

{"notes":"Test Notes for Name 2","endDate":"2010-09-01","name":"Test Name 2","startDate":"1990-02-04","entity":"http://localhost/14172496-c158-414b-a83b-48c0df7da465"}

4.5.2. Path Parameters

Table 17. /name/{id}
Parameter	Description
`id`	The UUID id of the Name to be replaced

4.5.3. Request Fields

Path Type Description

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

entity

String

The Entity associated with the Name

4.5.4. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 509

{
  "id" : "8e86459e-bd69-4219-9b17-afd417293b69",
  "name" : "Test Name 2",
  "startDate" : "1990-02-04",
  "endDate" : "2010-09-01",
  "notes" : "Test Notes for Name 2",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/name/8e86459e-bd69-4219-9b17-afd417293b69"
    },
    "name" : {
      "href" : "http://localhost:8080/name/8e86459e-bd69-4219-9b17-afd417293b69"
    },
    "entity" : {
      "href" : "http://localhost:8080/name/8e86459e-bd69-4219-9b17-afd417293b69/entity"
    }
  }
}

4.5.5. Response Fields

Path Type Description

id

String

The UUID id of the Name

name

String

The name property of the Name

notes

String

The notes used to describe the Name

startDate

String

The date the Name became active

endDate

String

The date the Name became inactive

_links

Object

A list of links associated with the Name

4.5.6. Links

Relation Description

self

The canoncial url for this Name

name

A link to the Name resource

entity

A link to the Entity associated with this Name

4.6. Delete

4.6.1. Request

DELETE /name/ff366b61-5904-4f31-a7a2-d3e53a2eff4c HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=
Host: localhost:8080

4.6.2. Path Parameters

Table 18. /name/{id}
Parameter	Description
`id`	The UUID id of the Name to delete

4.6.3. Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN

5. Simple Entity Resolver API

Endpoints for basic Entity resolving

5.1. Create with URL

5.1.1. Request

POST /entity HTTP/1.1
Accept: text/plain
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

url=http%3A%2F%2Fwww.example.com%2F1

5.1.2. Query Parameters

Parameter Description

url

The url of the desired Entity

5.1.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: text/plain
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 36

08fcc3f2-c531-47c8-afc3-7bbd6937cf2f

5.2. Resolve Id

5.2.1. Request

GET /entity/e9b54ed6-4469-497e-8da4-864129130d70 HTTP/1.1
Accept: text/plain
Host: localhost:8080

5.2.2. Path Parameters

Table 19. /entity/{id}
Parameter	Description
`id`	The id on the desired Entity

5.2.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: text/plain
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 24

http://www.example.com/1

5.3. Resolve URL

5.3.1. Request

GET /entity?url=http%3A%2F%2Fwww.example.com%2F1 HTTP/1.1
Accept: text/plain
Host: localhost:8080

5.3.2. Query Parameters

Parameter Description

url

The url on the desired Entity

5.3.3. Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: text/plain
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN
Content-Length: 36

560a627a-d065-47aa-9597-efe1b1ccc53e

5.4. Delete by Id

5.4.1. Request

DELETE /entity/fe4a286d-e9e7-4db2-940e-4f78ab46c261 HTTP/1.1
Accept: text/plain
Host: localhost:8080

5.4.2. Path Parameters

Table 20. /entity/{id}
Parameter	Description
`id`	The id on the desired Entity

5.4.3. Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: SAMEORIGIN