Member object
Fields
Field | Type | Description | Editable |
last_read_at_unix | integer | ||
unread_message_count | integer | ||
is_room_visible | boolean | ||
user_typing | string |
Filters
Field | Description |
id | ID |
room_id | RoomのID |
user_id | UserのID |
find member
GET
https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}
Headers
Name | Type | Description |
---|---|---|
X-Access-Token | string | set you access token |
Content-Type | string | application/vnd.api+json |
Accept | string | application/vnd.api+json |
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "1",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
},
"attributes": {
"last_read_at_unix": 1542602860,
"unread_message_count": 1,
"is_room_visible": true,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
},
"data": {
"type": "rooms",
"id": "1"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
},
"data": {
"type": "users",
"id": "2"
}
}
}
}
}
search members
GET
https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members
Headers
Name | Type | Description |
---|---|---|
X-Access-Token | string | set you access token |
Content-Type | string | application/vnd.api+json |
Accept | string | application/vnd.api+json |
{
"data": [
{
"id": "1",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
},
"attributes": {
"last_read_at_unix": 1542602860,
"unread_message_count": 1,
"is_room_visible": true,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
},
"data": {
"type": "rooms",
"id": "1"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
},
"data": {
"type": "users",
"id": "2"
}
}
}
},
{
"id": "2",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 0,
"is_room_visible": false,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/room"
},
"data": {
"type": "rooms",
"id": "3"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/user"
},
"data": {
"type": "users",
"id": "1"
}
}
}
},
{
"id": "3",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 1,
"is_room_visible": false,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/room"
},
"data": {
"type": "rooms",
"id": "1"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/user"
},
"data": {
"type": "users",
"id": "1"
}
}
}
},
{
"id": "5",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 0,
"is_room_visible": false,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/room"
},
"data": {
"type": "rooms",
"id": "5"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/user"
},
"data": {
"type": "users",
"id": "1"
}
}
}
},
{
"id": "6",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 1,
"is_room_visible": true,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/room"
},
"data": {
"type": "rooms",
"id": "6"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/user"
},
"data": {
"type": "users",
"id": "3"
}
}
}
},
{
"id": "7",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 0,
"is_room_visible": false,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/room"
},
"data": {
"type": "rooms",
"id": "6"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/user"
},
"data": {
"type": "users",
"id": "1"
}
}
}
}
],
"meta": {
"record_count": 6
},
"links": {
"first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members?page%5Bnumber%5D=1&page%5Bsize%5D=25",
"last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members?page%5Bnumber%5D=1&page%5Bsize%5D=25"
}
}
create member
POST
https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members
Headers
Name | Type | Description |
---|---|---|
Accept | string | application/vnd.api+json |
Content-Type | string | application/vnd.api+json |
X-Access-Token | string | set your access token |
Request Body
Name | Type | Description |
---|---|---|
data | object |
{
"data": {
"id": "8",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8"
},
"attributes": {
"last_read_at_unix": 0,
"unread_message_count": 2,
"is_room_visible": true,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/room"
},
"data": {
"type": "rooms",
"id": "1"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/user"
},
"data": {
"type": "users",
"id": "3"
}
}
}
}
}
update members
PUT
https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}
Headers
Name | Type | Description |
---|---|---|
X-Access-Token | string | set you access token |
Content-Type | string | application/vnd.api+json |
Accept | string | application/vnd.api+json |
Request Body
Name | Type | Description |
---|---|---|
data | object |
{
"data": {
"id": "1",
"type": "members",
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
},
"attributes": {
"last_read_at_unix": 1542602860,
"unread_message_count": 1,
"is_room_visible": true,
"user_typing": null
},
"relationships": {
"room": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
},
"data": {
"type": "rooms",
"id": "1"
}
},
"user": {
"links": {
"self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
"related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
},
"data": {
"type": "users",
"id": "2"
}
}
}
}
}
delete member
DELETE
https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}
Headers
Name | Type | Description |
---|---|---|
X-Access-Token | string | set you access token |
Content-Type | string | application/vnd.api+json |
Accept | string | application/vnd.api+json |
Completed 204 No Content
最終更新