Annotation
Fetching annotations via this endpoints.
#LIST
Return a collection of annotation.
#Example of fetching annotation list
Request
GET /annotations HTTP/1.1
Response
{
"data": [
{
"id": 1,
"handle": "fuga",
"description": {
"de": "Casey Homenick",
"en": "Herbert Watsica"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 2,
"handle": "doloribus",
"description": {
"de": "Dr. Orin Stiedemann IV",
"en": "Simone Baumbach"
},
"channels": [
{
"id": 1,
"handle": "customer",
"name": {
"de": "Endkunde"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 3,
"handle": "unde",
"description": {
"de": "Ellen Altenwerth MD",
"en": "Kendra Hauck IV"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 4,
"handle": "rerum",
"description": {
"de": "Karson Hamill",
"en": "Emelie Crooks"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 5,
"handle": "ipsam",
"description": {
"de": "Joan Quitzon",
"en": "Dorothea Schaefer DDS"
},
"channels": [
{
"id": 1,
"handle": "customer",
"name": {
"de": "Endkunde"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 6,
"handle": "alias",
"description": {
"de": "Prof. Winfield Toy III",
"en": "Adela Feil"
},
"channels": [
{
"id": 1,
"handle": "customer",
"name": {
"de": "Endkunde"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 7,
"handle": "esse",
"description": {
"de": "Helmer Champlin",
"en": "Dr. Fabian Stokes"
},
"channels": [
{
"id": 1,
"handle": "customer",
"name": {
"de": "Endkunde"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 8,
"handle": "natus",
"description": {
"de": "Fay Becker",
"en": "Mrs. Samanta Balistreri IV"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 9,
"handle": "inventore",
"description": {
"de": "Selena Stehr",
"en": "Ursula Kozey"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
},
{
"id": 10,
"handle": "possimus",
"description": {
"de": "Garett Funk",
"en": "Palma Smith"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
}
],
"links": {
"first": null,
"last": null,
"prev": null,
"next": null
},
"meta": {
"path": "https://api.smake.io/master-administration/annotations",
"per_page": 15,
"next_cursor": null,
"prev_cursor": null
}
}
#GET
Return a annotation of given id = x.
#Example of fetching specified annotation
Request
GET /annotations/1 HTTP/1.1
Response
{
"id": 1,
"handle": "fuga",
"description": {
"de": "Casey Homenick",
"en": "Herbert Watsica"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 3,
"handle": "production",
"name": {
"de": "Produktion"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-10T10:11:49+00:00",
"updated_at": "2023-01-10T10:11:49+00:00"
}
#CREATE
Create a new annotation.
#Channel Array
Array of annotation channel id's. Minimum 1 id is required. List of annotation channel can be found here. see Annotation Channel
#Example of creating a new annotation
Request
POST /annotations HTTP/1.1
{
"description": {
"de": "Hinweistext eins",
"en": "Annotation Text"
},
"handle": "annotation-1",
"channels": [
2,
1
]
}
Response
{
"id": 11,
"handle": "annotation-1",
"description": {
"de": "Hinweistext eins",
"en": "Annotation Text"
},
"channels": [
{
"id": 2,
"handle": "agent",
"name": {
"de": "Kundenbetreuer"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
},
{
"id": 1,
"handle": "customer",
"name": {
"de": "Endkunde"
},
"created_at": "2022-12-20T08:14:02+00:00",
"updated_at": "2022-12-20T08:14:02+00:00"
}
],
"created_at": "2023-01-16T14:21:11+00:00",
"updated_at": "2023-01-16T14:21:11+00:00"
}