Websites

ch:websites LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View websites collection
POST	Create new website
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
url	url	true	POST
comment	text	false	POST
page¹	integer	false	GET
per_page¹	integer	false	GET

See Pagination for details.

Profile

The Websites resource represents a collection of Website resources.

Properties

name	type	read-only
count	integer	true
page	integer	true
per_page	integer	true

Link relations

rel	conditional
self	false
first	true
last	true
prev	true
next	true
ch:application	false

Embedded

Website

Additional semantics

This collection is paginated. See Pagination.

Example representation

{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/websites"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:websites": [...]
  }
}