ToTheZeroth News

API Documentation

"Label" resource

Embedded as ttzn:label in the "labels" collection

The "label" resource models a specific label created by the authenticated user.

The resource is represented by an application/hal+json [draft] object with the following structure.

State properties
Property Type Mode Description
labelId Integer Read-only The numerical ID of the label
name String Required The name of the label
Resource links
Relation Description
curies A URI template [RFC6570] for expanding rel names with the ttzn prefix into the actual documentation URIs
Note: Not included when the resource is embedded in a collection
self The URI of the "label" resource
ttzn:posts A URI for fetching the items belonging to feeds with this label
up The URI of the "labels" collection
Note: Not included when the resource is embedded in the collection