Dieser Endpoint liefert eine User-Resource.

Dieser Endpoint liefert Daten zu einem User.

Read

Request

Beispiel: Daten zu User-ID 123456 anfragen

GET https://api.youthweb.net/users/123456
Accept: application/vnd.api+json, application/vnd.api+json; net.youthweb.api.version=0.17
Content-Type: application/vnd.api+json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0NTgyMzE2MDAsImlzcyI6IkpOdlBnY3ROcEg1Y0s2UmMifQ.BOn0XFDDYa5iBHJb636A0C0m4sU5NO8SA_CPOVHoWNs

Permissions

  • Allgemein: Du benötigst ein Access-Token, um auf diesen Endpoint zugreifen zu können.
  • Spezielle Felder: Der User kann den Zugriff auf die meisten Felder einschränken. Zugriff auf diese Felder benötigt dann einen bestimmten Scope.
  • Eingeschränkte User: Wenn der angefragte User seine Seite stark eingeschränkt hat, dann werden die meisten Felder null enthalten.
  • Blockierte User: Wenn der User, in dessen Namen der Client anfragt, auf der Blockierliste des angefragten Users steht, dann werden die meisten Felder null enthalten.

Parameter

Für den Request können keine Parameter angegeben werden.

Response

Status: 200 OK
Accept: application/vnd.api+json, application/vnd.api+json; net.youthweb.api.version=0.17
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "users",
        "id": "123456",
        "attributes": {
            "username": "JohnSmith",
            "first_name": "John",
            "last_name": "Smith",
            "gender": "male",
            "email": "john_smith@example.org",
            "birthday": "1988-03-05",
            "timezone": "Europe/Berlin",
            "created_at": "2008-11-01T20:00:00+00:00",
            "last_login": "2017-02-01T20:00:00+00:00",
            "zip": "12345",
            "city": "Jamestown",
            "contact_homepage": "https://example.org",
            "contact_twitter": "youthweb_dev",
            "description_text": "Lorem ipsum dolor sit amet",
            "description_character": "Lorem ipsum dolor sit amet",
            "description_jesus": "Lorem ipsum dolor sit amet",
            "description_job": "Lorem ipsum dolor sit amet",
            "description_hobbies": "Lorem ipsum dolor sit amet",
            "description_motto": "Lorem ipsum dolor sit amet",
            "description_food": "Lorem ipsum dolor sit amet",
            "description_links": "Lorem ipsum dolor sit amet",
            "picture_thumb_url": "https://youthweb.net/img/steckbriefe/default_pic_m.jpg",
            "picture_url": "https://youthweb.net/img/steckbriefe/default_pic_m.jpg"
            "picture_description": "Lorem ipsum dolor sit amet",
        },
        "links": {
            "self": "/users/123456"
        }
        "relationships": {
            "posts": "/users/123456/posts"
        }
    }
}

Felder

Name Beschreibung Typ
type Der Typ der Resource: users string
id Die ID der Resource string
attributes.username Der Username des Users string
attributes.first_name Der Vorname des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.last_name Der Nachname des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.gender Das Geschlecht des Users, male oder female oder null bei fehlender Berechtigung. string oder null
attributes.email Die E-Mail-Adresse des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:email oder user:read erfragt werden.		 string oder null
attributes.birthday Der Geburtstag des Users im Format YYYY-MM-DD oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.timezone Der eingestellte Name der Zeitzone des Users oder null bei fehlender Berechtigung. string oder null
attributes.created_at Der Registrierzeitpunkt des Users im Format nach ISO-8601 (2008-11-01T20:00:00+00:00) string
attributes.last_login Der Zeitpunkt des letzten Logins im Format nach ISO-8601 (2017-02-01T20:00:00+00:00) string
attributes.zip Die Postleitzahl des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.city Der Wohnort des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.contact_homepage Die Webseite des Users oder null bei fehlender Berechtigung. string oder null
attributes.contact_twitter Der Twitter-Username des Users oder null bei fehlender Berechtigung. string oder null
attributes.description_text Eine sonstige Beschreibung des Users oder null bei fehlender Berechtigung. string oder null
attributes.description_character Eine eigene Charakter-Beschreibung des Users oder null bei fehlender Berechtigung. string oder null
attributes.description_jesus “Was ich von Jesus halte” oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.description_job Der Beruf des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.description_hobbies Die Hobbies des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.description_motto Das Lebensmotto des Users oder null bei fehlender Berechtigung.
Kann mit dem Scope user:read erfragt werden.		 string oder null
attributes.description_food Das Lieblingsessen des Users oder null bei fehlender Berechtigung. string oder null
attributes.description_links Eine Empfehlung von Links des Users oder null bei fehlender Berechtigung. string oder null
attributes.picture_thumb_url Das Vorschaubild des Profilbildes string
attributes.picture_url Das Profilbild string
attributes.picture_description Eine Beschreibung des Profilbildes oder null bei fehlender Berechtigung. string oder null

Create

Du kannst mit diesem Endpoint nichts erstellen.

Delete

Du kannst mit diesem Endpoint nichts löschen.

Update

Du kannst mit diesem Endpoint nichts ändern.

Beziehungen

Beziehung Beschreibung
/users/{user_id}/posts Liefert die Post-Resourcen von der Pinnwand eines Users
/users/{user_id}/relationships/posts Liefert ein Array von Resource Identifier Objekt zu den Posts
Tags: endpoint
Bearbeiten