1. Overview

Juick REST API Documentation

1.1. Version information

Version : 2.0

1.2. License information

License : AGPLv3
License URL : https://www.gnu.org/licenses/agpl-3.0.html
Terms of service : https://juick.com/help/tos

1.3. URI scheme

Host : api.juick.com
BasePath : /

1.4. Tags

  • api-social-login : Api Social Login

  • app-site-association : App Site Association

  • feeds : Feeds

  • host-meta : Host Meta

  • info : Info

  • messages : Messages

  • notifications : Notifications

  • pm : PM

  • post : Post

  • profile : Profile

  • resource : Resource

  • service : Service

  • tags : Tags

  • users : Users

2. Resources

2.1. Api-social-login

Api Social Login

2.1.1. doFacebookLogin

GET /api/_fblogin
Parameters
Type Name Description Schema

Query

code
optional

code

string

Query

state
optional

state

string
Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.1.2. googleSignIn

POST /api/_google
Parameters
Type Name Description Schema

Query

idToken
required

idToken

string
Responses
HTTP Code Description Schema

200

OK

Auth

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.1.3. doVKLogin

GET /api/_vklogin
Parameters
Type Name Description Schema

Query

code
optional

code

string

Query

state
required

state

string
Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.1.4. signupWithEmail

POST /api/signup
Parameters
Type Name Description Schema

Query

password
optional

password

string

Query

username
optional

username

string

Query

verificationCode
optional

verificationCode

string
Responses
HTTP Code Description Schema

200

OK

User

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.2. App-site-association

App Site Association

2.2.1. appSiteAssociations

GET /.well-known/apple-app-site-association
Responses
HTTP Code Description Schema

200

OK

SiteAssociations

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.3. Feeds

Feeds

2.3.1. getLast

GET /rss/
Parameters
Type Name Description Schema Default

Query

hours
optional

hours

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

ModelAndView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • text/xml;charset=utf-8

2.3.2. getLastReplies

GET /rss/comments
Parameters
Type Name Description Schema Default

Query

hours
optional

hours

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

ModelAndView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • text/xml;charset=utf-8

2.3.3. getBlog

GET /rss/{userName}/blog
Parameters
Type Name Description Schema

Path

userName
required

userName

string
Responses
HTTP Code Description Schema

200

OK

ModelAndView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • text/xml;charset=utf-8

2.4. Host-meta

Host Meta

2.4.1. hostMetaResponse

GET /.well-known/host-meta
Responses
HTTP Code Description Schema

200

OK

XRD

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/xrd+xml

2.5. Info

Info

2.5.1. showNodeInfo

GET /.well-known/x-nodeinfo2
Responses
HTTP Code Description Schema

200

OK

NodeInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.6. Messages

Messages

2.6.1. getHome

GET /api/home
Parameters
Type Name Description Schema Default

Query

before_mid
optional

before_mid

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

< Message > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.6.2. getMessages

GET /api/messages
Parameters
Type Name Description Schema Default

Query

before_mid
optional

before_mid

integer (int32)

0

Query

daysback
optional

daysback

integer (int32)

0

Query

media
optional

media

string

Query

page
optional

page

integer (int32)

0

Query

popular
optional

popular

string

Query

search
optional

search

string

Query

tag
optional

tag

string

Query

uname
optional

uname

string

Query

withrecommended
optional

withrecommended

string
Responses
HTTP Code Description Schema

200

OK

< Message > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.6.3. deleteMessage

DELETE /api/messages
Parameters
Type Name Description Schema Default

Query

mid
required

mid

integer (int32)

Query

rid
optional

rid

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

CommandResult

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Produces

  • application/json;charset=UTF-8

2.6.4. getDiscussions

GET /api/messages/discussions
Parameters
Type Name Description Schema Default

Query

to
optional

to

integer (int64)

0
Responses
HTTP Code Description Schema

200

OK

< Message > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.6.5. getThread

GET /api/thread
Parameters
Type Name Description Schema Default

Query

mid
optional

mid

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

< Message > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.6.6. markThreadRead

GET /api/thread/mark_read/{mid}-{rid}.gif
Parameters
Type Name Description Schema

Path

mid
required

mid

integer (int32)

Path

rid
required

rid

integer (int32)
Responses
HTTP Code Description Schema

200

OK

string (byte)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • image/gif

2.7. Notifications

Notifications

2.7.1. doAndroidRegister

GET /api/android/register
Caution

operation.deprecated
Parameters
Type Name Description Schema

Query

regid
required

regid

string
Responses
HTTP Code Description Schema

200

OK

Status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.7.2. doAndroidUnRegister

GET /api/android/unregister
Caution

operation.deprecated
Parameters
Type Name Description Schema

Query

regid
required

regid

string
Responses
HTTP Code Description Schema

200

OK

Status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.7.3. doWinphoneRegister

GET /api/winphone/register
Caution

operation.deprecated
Parameters
Type Name Description Schema

Query

name
optional

string

Query

url
required

url

string
Responses
HTTP Code Description Schema

200

OK

Status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.7.4. doWinphoneUnRegister

GET /api/winphone/unregister
Caution

operation.deprecated
Parameters
Type Name Description Schema

Query

url
required

url

string
Responses
HTTP Code Description Schema

200

OK

Status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.8. Pm

PM

2.8.1. doGetGroupsPMs

GET /api/groups_pms
Parameters
Type Name Description Schema Default

Query

cnt
optional

cnt

integer (int32)

5
Responses
HTTP Code Description Schema

200

OK

PrivateChats

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.8.2. doPostPM

POST /api/pm
Parameters
Type Name Description Schema

Query

body
required

body

string

Query

uname
required

uname

string
Responses
HTTP Code Description Schema

200

OK

Message

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

2.8.3. doGetPM

GET /api/pm
Parameters
Type Name Description Schema

Query

uname
optional

uname

string
Responses
HTTP Code Description Schema

200

OK

< Message > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.9. Post

Post

2.9.1. doPostComment

POST /api/comment
Parameters
Type Name Description Schema Default

Query

body
optional

body

string

Query

img
optional

img

string

Query

mid
optional

mid

integer (int32)

0

Query

rid
optional

rid

integer (int32)

0

FormData

attach
optional

attach

file
Responses
HTTP Code Description Schema

200

OK

CommandResult

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • multipart/form-data

Produces

  • application/json;charset=UTF-8

2.9.2. doPostRecomm

POST /api/like
Parameters
Type Name Description Schema

Query

mid
required

mid

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Status

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.9.3. doPostMessage

POST /api/post
Parameters
Type Name Description Schema

Query

body
optional

body

string

Query

img
optional

img

string

FormData

attach
optional

attach

file
Responses
HTTP Code Description Schema

200

OK

CommandResult

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • multipart/form-data

Produces

  • application/json;charset=UTF-8

2.9.4. doPostReact

POST /api/react
Parameters
Type Name Description Schema Default

Query

count
optional

count

integer (int32)

1

Query

mid
required

mid

integer (int32)

Query

reactionId
required

reactionId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Status

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.9.5. reactionsList

GET /api/reactions
Responses
HTTP Code Description Schema

200

OK

< Reaction > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.9.6. doPostSubscribe

POST /api/subscribe
Parameters
Type Name Description Schema

Query

mid
required

mid

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Status

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.9.7. updateMessage

POST /api/update
Parameters
Type Name Description Schema Default

Query

body
required

body

string

Query

mid
required

mid

integer (int32)

Query

rid
optional

rid

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

CommandResult

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • */*

2.10. Profile

Profile

2.10.1. processInbox

POST /api/inbox
Parameters
Type Name Description Schema

Header

Accept-Encoding
optional

Accept-Encoding

string

Header

Content-Type
required

Content-Type

string

Header

Date
required

Date

string

Header

Digest
optional

Digest

string

Header

Host
required

Host

string

Header

Signature
optional

Signature

string

Header

User-Agent
optional

User-Agent

string

Body

activity
required

activity

Activity
Responses
HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

Produces

  • */*

2.10.2. showNote

GET /n/{mid}-{rid}
Parameters
Type Name Description Schema

Path

mid
required

mid

integer (int32)

Path

rid
required

rid

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Context

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.3. fetchUser

POST /u/
Parameters
Type Name Description Schema

Query

uri
required

uri

string
Responses
HTTP Code Description Schema

200

OK

User

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

2.10.4. getUser

GET /u/{userName}
Parameters
Type Name Description Schema

Path

userName
required

userName

string
Responses
HTTP Code Description Schema

200

OK

Person

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.5. getOutboxPage

GET /u/{userName}/blog
Parameters
Type Name Description Schema Default

Path

userName
required

userName

string

Query

before
optional

before

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

OrderedCollectionPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.6. getOutbox

GET /u/{userName}/blog/toc
Parameters
Type Name Description Schema

Path

userName
required

userName

string
Responses
HTTP Code Description Schema

200

OK

OrderedCollection

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.7. getFollowersPage

GET /u/{userName}/followers
Parameters
Type Name Description Schema Default

Path

userName
required

userName

string

Query

page
optional

page

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

OrderedCollectionPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.8. getFollowers

GET /u/{userName}/followers/toc
Parameters
Type Name Description Schema

Path

userName
required

userName

string
Responses
HTTP Code Description Schema

200

OK

OrderedCollection

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.9. getFollowingPage

GET /u/{userName}/following
Parameters
Type Name Description Schema Default

Path

userName
required

userName

string

Query

page
optional

page

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

OrderedCollectionPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.10.10. getFollowing

GET /u/{userName}/following/toc
Parameters
Type Name Description Schema

Path

userName
required

userName

string
Responses
HTTP Code Description Schema

200

OK

OrderedCollection

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/ld+json;profile="https://www.w3.org/ns/activitystreams"

  • application/activity+json;profile="https://www.w3.org/ns/activitystreams"

2.11. Resource

Resource

2.11.1. getWebResource

GET /.well-known/webfinger
Parameters
Type Name Description Schema

Query

resource
required

resource

string
Responses
HTTP Code Description Schema

200

OK

Account

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.12. Service

Service

2.12.1. handle

GET /api/events
Responses
HTTP Code Description Schema

200

OK

SseEmitter

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.13. Tags

Tags

2.13.1. tags

GET /api/tags
Parameters
Type Name Description Schema Default

Query

user_id
optional

user_id

integer (int32)

0
Responses
HTTP Code Description Schema

200

OK

< TagStats > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.14. Users

Users

2.14.1. getAuthToken

GET /api/auth
Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.14.2. getUserInfo

GET /api/info/{uname}
Parameters
Type Name Description Schema

Path

uname
required

uname

string
Responses
HTTP Code Description Schema

200

OK

UserInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.14.3. getMe

GET /api/me
Responses
HTTP Code Description Schema

200

OK

SecureUser

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • */*

2.14.4. doGetUsers

GET /api/users
Parameters
Type Name Description Schema

Query

uname
optional

uname

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

< User > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.14.5. doGetUserRead

GET /api/users/read
Parameters
Type Name Description Schema

Query

uname
required

uname

string
Responses
HTTP Code Description Schema

200

OK

< User > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

2.14.6. doGetUserReaders

GET /api/users/readers
Parameters
Type Name Description Schema

Query

uname
required

uname

string
Responses
HTTP Code Description Schema

200

OK

< User > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

3. Definitions

3.1. Accept

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.2. Account

Name Schema

links
optional

< Link > array

subject
optional

string

3.3. Activity

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.4. Alias

Name Schema

unknownAttributes
optional

< string, object > map

value
optional

URI

3.5. Announce

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.6. ApplicationStatus

Name Schema

connected
optional

boolean

crosspostEnabled
optional

boolean

3.7. Attachment

Name Schema

height
optional

integer (int32)

medium
optional

Attachment

small
optional

Attachment

thumbnail
optional

Attachment

url
optional

string

width
optional

integer (int32)

3.8. Auth

Name Schema

account
optional

string

authCode
optional

string

3.9. Block

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.10. Chat

Name Description Schema

avatar
optional

string

banned
optional

boolean

fullname
optional

string

lastMessageText
optional

string

lastMessageTimestamp
optional

Example : "yyyy-MM-dd HH:mm:ss"

string

messagesCount
optional

integer (int32)

read
optional

< User > array

readers
optional

< User > array

seen
optional

string (date-time)

tokens
optional

< ExternalToken > array

uid
optional

integer (int32)

uname
optional

string

unread
optional

< integer (int32) > array

unreadCount
optional

integer (int32)

uri
optional

URI

3.11. CommandResult

Name Schema

markdown
optional

string

newMessage
optional

Optional«Message»

text
optional

string

3.12. Context

Name Schema

@context
optional

< object > array

id
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.13. Create

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.14. DOMConfiguration

Name Schema

parameterNames
optional

DOMStringList

3.15. DOMImplementation

Type : object

3.16. DOMStringList

Name Schema

length
optional

integer (int32)

3.17. Delete

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.18. Document

Name Schema

attributes
optional

NamedNodeMap

baseURI
optional

string

childNodes
optional

NodeList

doctype
optional

DocumentType

documentElement
optional

Element

documentURI
optional

string

domConfig
optional

DOMConfiguration

firstChild
optional

Node

implementation
optional

DOMImplementation

inputEncoding
optional

string

lastChild
optional

Node

localName
optional

string

namespaceURI
optional

string

nextSibling
optional

Node

nodeName
optional

string

nodeType
optional

integer (int32)

nodeValue
optional

string

ownerDocument
optional

Document

parentNode
optional

Node

prefix
optional

string

previousSibling
optional

Node

strictErrorChecking
optional

boolean

textContent
optional

string

xmlEncoding
optional

string

xmlStandalone
optional

boolean

xmlVersion
optional

string

3.19. DocumentType

Name Schema

attributes
optional

NamedNodeMap

baseURI
optional

string

childNodes
optional

NodeList

entities
optional

NamedNodeMap

firstChild
optional

Node

internalSubset
optional

string

lastChild
optional

Node

localName
optional

string

name
optional

string

namespaceURI
optional

string

nextSibling
optional

Node

nodeName
optional

string

nodeType
optional

integer (int32)

nodeValue
optional

string

notations
optional

NamedNodeMap

ownerDocument
optional

Document

parentNode
optional

Node

prefix
optional

string

previousSibling
optional

Node

publicId
optional

string

systemId
optional

string

textContent
optional

string

3.20. Element

Name Schema

attributes
optional

NamedNodeMap

baseURI
optional

string

childNodes
optional

NodeList

firstChild
optional

Node

lastChild
optional

Node

localName
optional

string

namespaceURI
optional

string

nextSibling
optional

Node

nodeName
optional

string

nodeType
optional

integer (int32)

nodeValue
optional

string

ownerDocument
optional

Document

parentNode
optional

Node

prefix
optional

string

previousSibling
optional

Node

schemaTypeInfo
optional

TypeInfo

tagName
optional

string

textContent
optional

string

3.21. Entity

Name Schema

end
optional

integer (int32)

start
optional

integer (int32)

text
optional

string

type
optional

string

url
optional

string

3.22. Expires

Name Schema

unknownAttributes
optional

< string, object > map

value
optional

string (date-time)

3.23. ExternalToken

Name Schema

name
optional

string

secret
optional

string

token
optional

string

type
optional

string

3.24. Follow

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.25. Hashtag

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

id
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.26. Image

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

id
optional

string

mediaType
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.27. Key

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

id
optional

string

name
optional

string

owner
optional

string

publicKeyPem
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.28. Like

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.29. Link

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

href
optional

string

id
optional

string

name
optional

string

published
optional

string (date-time)

rel
optional

string

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.30. Mention

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

href
optional

string

id
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.31. Message

Name Description Schema

attach
optional

string

attachment
optional

Attachment

body
optional

string

entities
optional

< Entity > array

html
optional

boolean

likes
optional

integer (int32)

mid
optional

integer (int32)

photo
optional

Photo

reactions
optional

< Reaction > array

recommendations
optional

< string > array

replies
optional

integer (int32)

repliesby
optional

string

replyQuote
optional

string

replyToUri
optional

URI

replyUri
optional

URI

replyto
optional

integer (int32)

rid
optional

integer (int32)

service
optional

boolean

tags
optional

< Tag > array

timestamp
optional

Example : "yyyy-MM-dd HH:mm:ss"

string

to
optional

User

unread
optional

boolean

updated
optional

string (date-time)

updated_at
optional

Example : "yyyy-MM-dd HH:mm:ss"

string

user
optional

User

3.32. ModelAndView

Name Schema

empty
optional

boolean

model
optional

object

modelMap
optional

< string, object > map

reference
optional

boolean

status
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

view
optional

View

viewName
optional

string

3.33. NamedNodeMap

Name Schema

length
optional

integer (int32)

3.34. Node

Name Schema

attributes
optional

NamedNodeMap

baseURI
optional

string

childNodes
optional

NodeList

firstChild
optional

Node

lastChild
optional

Node

localName
optional

string

namespaceURI
optional

string

nextSibling
optional

Node

nodeName
optional

string

nodeType
optional

integer (int32)

nodeValue
optional

string

ownerDocument
optional

Document

parentNode
optional

Node

prefix
optional

string

previousSibling
optional

Node

textContent
optional

string

3.35. NodeInfo

Name Schema

openRegistrations
optional

boolean

protocols
optional

< string > array

server
optional

Server

services
optional

ServiceInfo

usage
optional

Usage

version
optional

string

3.36. NodeList

Name Schema

length
optional

integer (int32)

3.37. Note

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

attachment
optional

< Image > array

attributedTo
optional

string

cc
optional

< string > array

content
optional

string

id
optional

string

inReplyTo
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.38. Optional«Message»

Name Schema

present
optional

boolean

3.39. OrderedCollection

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

first
optional

string

id
optional

string

name
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

totalItems
optional

integer (int32)

type
optional

string

url
optional

string

3.40. OrderedCollectionPage

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

first
optional

string

id
optional

string

last
optional

string

name
optional

string

next
optional

string

orderedItems
optional

< Context > array

partOf
optional

string

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.41. Person

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

followers
optional

string

following
optional

string

icon
optional

Image

id
optional

string

inbox
optional

string

name
optional

string

outbox
optional

string

preferredUsername
optional

string

publicKey
optional

Key

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.42. Photo

Name Schema

medium
optional

string

small
optional

string

thumbnail
optional

string

3.43. PrivateChats

Name Schema

pms
optional

< Chat > array

3.44. Property

Name Schema

type
optional

URI

unknownAttributes
optional

< string, object > map

value
optional

URI

3.45. Reaction

Name Schema

count
optional

integer (int32)

description
optional

string

id
optional

integer (int32)

3.46. SecureUser

Name Schema

activeEmail
optional

string

avatar
optional

string

banned
optional

boolean

emails
optional

< string > array

facebookStatus
optional

ApplicationStatus

fullname
optional

string

hash
optional

string

jids
optional

< string > array

messagesCount
optional

integer (int32)

read
optional

< User > array

readers
optional

< User > array

seen
optional

string (date-time)

telegramName
optional

string

tokens
optional

< ExternalToken > array

twitterName
optional

string

uid
optional

integer (int32)

uname
optional

string

unread
optional

< integer (int32) > array

unreadCount
optional

integer (int32)

uri
optional

URI

userInfo
optional

UserInfo

3.47. Server

Name Schema

baseUrl
optional

string

name
optional

string

software
optional

string

version
optional

string

3.48. ServiceInfo

Name Schema

inbound
optional

< string > array

outbound
optional

< string > array

3.49. Signature

Type : object

3.50. SiteAssociations

Name Schema

webcredentials
optional

WebCredentials

3.51. SseEmitter

Name Schema

timeout
optional

integer (int64)

3.52. Status

Name Schema

status
optional

string

3.53. Subject

Name Schema

unknownAttributes
optional

< string, object > map

value
optional

URI

3.54. Tag

Name Schema

SynonymID
optional

integer (int32)

TID
optional

integer (int32)

3.55. TagStats

Name Schema

messages
optional

integer (int32)

tag
optional

Tag

3.56. Title

Name Schema

lang
optional

string

unknownAttributes
optional

< string, object > map

value
optional

string

3.57. TypeInfo

Name Schema

typeName
optional

string

typeNamespace
optional

string

3.58. URI

Name Schema

absolute
optional

boolean

authority
optional

string

fragment
optional

string

host
optional

string

opaque
optional

boolean

path
optional

string

port
optional

integer (int32)

query
optional

string

rawAuthority
optional

string

rawFragment
optional

string

rawPath
optional

string

rawQuery
optional

string

rawSchemeSpecificPart
optional

string

rawUserInfo
optional

string

scheme
optional

string

schemeSpecificPart
optional

string

userInfo
optional

string

3.59. Undo

Polymorphism : Inheritance
Discriminator : type

Name Schema

@context
optional

< object > array

actor
optional

string

id
optional

string

name
optional

string

object
optional

object

published
optional

string (date-time)

tag
optional

< Context > array

to
optional

< string > array

type
optional

string

url
optional

string

3.60. Usage

Name Schema

localComments
optional

integer (int32)

localPosts
optional

integer (int32)

users
optional

UserStats

3.61. User

Name Schema

avatar
optional

string

banned
optional

boolean

fullname
optional

string

messagesCount
optional

integer (int32)

read
optional

< User > array

readers
optional

< User > array

seen
optional

string (date-time)

tokens
optional

< ExternalToken > array

uid
optional

integer (int32)

uname
optional

string

unread
optional

< integer (int32) > array

unreadCount
optional

integer (int32)

uri
optional

URI

3.62. UserInfo

Name Schema

country
optional

string

description
optional

string

fullName
optional

string

url
optional

string

3.63. UserStats

Name Schema

activeHalfyear
optional

integer (int32)

activeMonth
optional

integer (int32)

total
optional

integer (int32)

3.64. View

Name Schema

contentType
optional

string

3.65. WebCredentials

Name Schema

apps
optional

< string > array

3.66. XRD

Name Schema

aliases
optional

< Alias > array

expires
optional

Expires

id
optional

string

links
optional

< Link > array

properties
optional

< Property > array

signatures
optional

< Signature > array

subject
optional

Subject

unknownAttributes
optional

< string, object > map

unknownElements
optional

< Element > array