User

The information stored for a Skylar User Account.

Details

See Application-Level Profile Semantics (ALPS)

Curl request

$ curl 'http://skylar.livingfire.de/api/profile/users' -i -X GET

Create

A POST request will create a User.

Curl request

$ curl 'http://skylar.livingfire.de/api/users' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "id" : null,
  "uuid" : "9ea65c1c-ae99-4a1a-b840-e8d7f5ec2c10",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Thomas",
  "relationSettingsSetBy" : [ ],
  "relationListdatasCanView" : [ ],
  "locationConfiguration" : {
    "language" : "de",
    "region" : "DE",
    "timeZoneString" : "Europe/Berlin",
    "locale" : "de_DE",
    "zoneId" : "Europe/Berlin",
    "zonedDateTime" : "2019-01-28T16:08:13.091+01:00"
  },
  "ttsConfiguration" : {
    "ttsGender" : "female",
    "ttsLanguage" : "de",
    "location" : {
      "language" : "de",
      "region" : "DE",
      "timeZoneString" : "Europe/Berlin",
      "locale" : "de_DE",
      "zoneId" : "Europe/Berlin",
      "zonedDateTime" : "2019-01-28T16:08:13.093+01:00"
    }
  }
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/users/6

Retrieve

A GET request will retrieve a User.

Response fields

Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

_links

Object

Links to other resources

locationConfiguration.language

String

LocationConfiguration - language e.g. de

locationConfiguration.region

String

LocationConfiguration - region e.g. DE

locationConfiguration.timeZoneString

String

LocationConfiguration - timeZoneString e.g. Europe/Berlin

locationConfiguration.locale

String

LocationConfiguration - locale e.g. de_DE

locationConfiguration.zoneId

String

LocationConfiguration - zoneId e.g. Europe/Berlin

locationConfiguration.zonedDateTime

String

LocationConfiguration - zonedDateTime e.g. 2017-11-02T19:24:13.514+01:00

ttsConfiguration.

Object

TtsConfiguration - e.g.

ttsConfiguration.ttsGender

String

TtsConfiguration ttsGender - e.g. female

ttsConfiguration.ttsLanguage

String

TtsConfiguration ttsLanguage - e.g. german

ttsConfiguration.location.language

String

LocationConfiguration - language e.g. de

ttsConfiguration.location.region

String

LocationConfiguration - region e.g. DE

ttsConfiguration.location.timeZoneString

String

LocationConfiguration - timeZoneString e.g. Europe/Berlin

ttsConfiguration.location.locale

String

LocationConfiguration - locale e.g. de_DE

ttsConfiguration.location.zoneId

String

LocationConfiguration - zoneId e.g. Europe/Berlin

ttsConfiguration.location.zonedDateTime

String

LocationConfiguration - zonedDateTime e.g. 2017-11-02T19:24:13.514+01:00

Curl request

$ curl 'http://skylar.livingfire.de/api/users/6' -i -X GET

HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1088

{
  "uuid" : "9ea65c1c-ae99-4a1a-b840-e8d7f5ec2c10",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Thomas",
  "locationConfiguration" : {
    "language" : "de",
    "region" : "DE",
    "timeZoneString" : "Europe/Berlin",
    "locale" : "de_DE",
    "zoneId" : "Europe/Berlin",
    "zonedDateTime" : "2019-01-28T16:08:13.188+01:00"
  },
  "ttsConfiguration" : {
    "ttsGender" : "female",
    "ttsLanguage" : "de",
    "location" : {
      "language" : "de",
      "region" : "DE",
      "timeZoneString" : "Europe/Berlin",
      "locale" : "de_DE",
      "zoneId" : "Europe/Berlin",
      "zonedDateTime" : "2019-01-28T16:08:13.192+01:00"
    }
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/users/6"
    },
    "user" : {
      "href" : "http://skylar.livingfire.de/api/users/6"
    },
    "relationListdatasCanView" : {
      "href" : "http://skylar.livingfire.de/api/users/6/relationListdatasCanView"
    },
    "relationSettingsSetBy" : {
      "href" : "http://skylar.livingfire.de/api/users/6/relationSettingsSetBy"
    }
  }
}
Relation Description

self

Canonical link for this resource

user

This User

relationListdatasCanView

Relation ListDatas

relationSettingsSetBy

Relation Settings

Update

A PATCH request will update a User.

Curl request

$ curl 'http://skylar.livingfire.de/api/users/6' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "description" : "Skylar"
}'

HTTP response

HTTP/1.1 204 No Content

Delete

A DELETE request will delete a User.

Curl request

$ curl 'http://skylar.livingfire.de/api/users/6' -i -X DELETE \
    -H 'Content-Type: application/hal+json'

HTTP response

HTTP/1.1 204 No Content

Details

See Application-Level Profile Semantics (ALPS)

Curl request
$ curl 'http://skylar.livingfire.de/api/users/search' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 521

{
  "_links" : {
    "findByUuid" : {
      "href" : "http://skylar.livingfire.de/api/users/search/findByUuid{?uuid}",
      "templated" : true
    },
    "findByDescription" : {
      "href" : "http://skylar.livingfire.de/api/users/search/findByDescription{?description}",
      "templated" : true
    },
    "exportAllRelationsToCsv" : {
      "href" : "http://skylar.livingfire.de/api/users/search/exportAllRelationsToCsv"
    },
    "self" : {
      "href" : "http://skylar.livingfire.de/api/users/search"
    }
  }
}

findByUuid

A GET request will retrieve a User.

Request parameters
Parameter Description

uuid

Java UUID
Response fields
Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

_links

Object

Links to other resources

locationConfiguration.language

String

LocationConfiguration - language e.g. de

locationConfiguration.region

String

LocationConfiguration - region e.g. DE

locationConfiguration.timeZoneString

String

LocationConfiguration - timeZoneString e.g. Europe/Berlin

locationConfiguration.locale

String

LocationConfiguration - locale e.g. de_DE

locationConfiguration.zoneId

String

LocationConfiguration - zoneId e.g. Europe/Berlin

locationConfiguration.zonedDateTime

String

LocationConfiguration - zonedDateTime e.g. 2017-11-02T19:24:13.514+01:00

ttsConfiguration.

Object

TtsConfiguration - e.g.

ttsConfiguration.ttsGender

String

TtsConfiguration ttsGender - e.g. female

ttsConfiguration.ttsLanguage

String

TtsConfiguration ttsLanguage - e.g. german

ttsConfiguration.location.language

String

LocationConfiguration - language e.g. de

ttsConfiguration.location.region

String

LocationConfiguration - region e.g. DE

ttsConfiguration.location.timeZoneString

String

LocationConfiguration - timeZoneString e.g. Europe/Berlin

ttsConfiguration.location.locale

String

LocationConfiguration - locale e.g. de_DE

ttsConfiguration.location.zoneId

String

LocationConfiguration - zoneId e.g. Europe/Berlin

ttsConfiguration.location.zonedDateTime

String

LocationConfiguration - zonedDateTime e.g. 2017-11-02T19:24:13.514+01:00
Curl request
$ curl 'http://skylar.livingfire.de/api/users/search/findByUuid?uuid=9ea65c1c-ae99-4a1a-b840-e8d7f5ec2c10' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1088

{
  "uuid" : "9ea65c1c-ae99-4a1a-b840-e8d7f5ec2c10",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "Skylar",
  "locationConfiguration" : {
    "language" : "de",
    "region" : "DE",
    "timeZoneString" : "Europe/Berlin",
    "locale" : "de_DE",
    "zoneId" : "Europe/Berlin",
    "zonedDateTime" : "2019-01-28T16:08:13.386+01:00"
  },
  "ttsConfiguration" : {
    "ttsGender" : "female",
    "ttsLanguage" : "de",
    "location" : {
      "language" : "de",
      "region" : "DE",
      "timeZoneString" : "Europe/Berlin",
      "locale" : "de_DE",
      "zoneId" : "Europe/Berlin",
      "zonedDateTime" : "2019-01-28T16:08:13.387+01:00"
    }
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/users/6"
    },
    "user" : {
      "href" : "http://skylar.livingfire.de/api/users/6"
    },
    "relationListdatasCanView" : {
      "href" : "http://skylar.livingfire.de/api/users/6/relationListdatasCanView"
    },
    "relationSettingsSetBy" : {
      "href" : "http://skylar.livingfire.de/api/users/6/relationSettingsSetBy"
    }
  }
}
Relation Description

self

Canonical link for this resource

user

This User

relationListdatasCanView

Relation ListDatas

relationSettingsSetBy

Relation Settings

findByDescription

A GET request will retrieve a array of User.

Request parameters
Parameter Description

description

Description or name
Response fields
Path Type Description

_embedded.users

Array

An array of User

_links

Object

Links to other resources
Curl request
$ curl 'http://skylar.livingfire.de/api/users/search/findByDescription?description=Thomas' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 164

{
  "_embedded" : {
    "users" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/users/search/findByDescription"
    }
  }
}
Relation Description

self

Canonical link for this resource

Users

Listing

A GET request will retrieve a paginated view of all User.

Response fields

Path Type Description

_embedded.users

Array

An array of User

_links

Object

Links to other resources

page

Object

paging information

Curl request

$ curl 'http://skylar.livingfire.de/api/users' -i -X GET

HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1696

{
  "_embedded" : {
    "users" : [ {
      "uuid" : "9ea65c1c-ae99-4a1a-b840-e8d7f5ec2c10",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "Skylar",
      "locationConfiguration" : {
        "language" : "de",
        "region" : "DE",
        "timeZoneString" : "Europe/Berlin",
        "locale" : "de_DE",
        "zoneId" : "Europe/Berlin",
        "zonedDateTime" : "2019-01-28T16:08:13.336+01:00"
      },
      "ttsConfiguration" : {
        "ttsGender" : "female",
        "ttsLanguage" : "de",
        "location" : {
          "language" : "de",
          "region" : "DE",
          "timeZoneString" : "Europe/Berlin",
          "locale" : "de_DE",
          "zoneId" : "Europe/Berlin",
          "zonedDateTime" : "2019-01-28T16:08:13.336+01:00"
        }
      },
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/users/6"
        },
        "user" : {
          "href" : "http://skylar.livingfire.de/api/users/6"
        },
        "relationListdatasCanView" : {
          "href" : "http://skylar.livingfire.de/api/users/6/relationListdatasCanView"
        },
        "relationSettingsSetBy" : {
          "href" : "http://skylar.livingfire.de/api/users/6/relationSettingsSetBy"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/users{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "http://skylar.livingfire.de/api/profile/users"
    },
    "search" : {
      "href" : "http://skylar.livingfire.de/api/users/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Relation Description

self

Canonical link for this resource

profile

The Application-Level Profile Semantics (ALPS)

search

Canonical link to search resources