Friendship
Catalog
- Mine
- Delete friend
- Create request
- Complete request
- My requests
- Search everything
- Discover friends
- User detail
- Report him
GET Mine
Request path:
https://server.kahla.app/Friendship/Mine
Request example:
https://server.kahla.app/Friendship/Mine
Possible Response:
{
"users": [
{
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.180192Z",
"emailConfirmed": true
}
],
"groups": [
{
"imagePath": "an example string.",
"name": "an example string.",
"hasPassword": true,
"ownerId": "an example string.",
"id": 0,
"hasTimer": true,
"conversationCreateTime": "2023-10-01T22:26:05.1807825Z"
}
],
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Delete friend
Request path:
https://server.kahla.app/Friendship/DeleteFriend
Request example:
https://server.kahla.app/Friendship/DeleteFriend?id=yourid
Request content type:
application/x-www-form-urlencoded
Form content example:
id=yourid
Request form:
Name | Required | Type |
---|---|---|
id | Required | Text |
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Create request
Request path:
https://server.kahla.app/Friendship/CreateRequest
Request example:
https://server.kahla.app/Friendship/CreateRequest?id=yourid
Request content type:
application/x-www-form-urlencoded
Form content example:
id=yourid
Request form:
Name | Required | Type |
---|---|---|
id | Required | Text |
Possible Response:
{
"value": 0,
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Complete request
Request path:
https://server.kahla.app/Friendship/CompleteRequest
Request example:
https://server.kahla.app/Friendship/CompleteRequest?Id=0&Accept=false
Request content type:
application/x-www-form-urlencoded
Form content example:
Id=0&Accept=false
Request form:
Name | Required | Type |
---|---|---|
Id | Required | Number |
Accept | Required | Boolean |
Possible Response:
{
"value": 0,
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
GET My requests
Request path:
https://server.kahla.app/Friendship/MyRequests
Request example:
https://server.kahla.app/Friendship/MyRequests
Possible Response:
{
"items": [
{
"id": 0,
"creatorId": "an example string.",
"creator": {
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.1881925Z",
"emailConfirmed": true
},
"targetId": "an example string.",
"createTime": "2023-10-01T22:26:05.1883651Z",
"completed": true
}
],
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
GET Search everything
Request path:
https://server.kahla.app/Friendship/SearchEverything
Request example:
https://server.kahla.app/Friendship/SearchEverything?SearchInput=yourSearchInput&Take=0
Request arguments:
Name | Required | Type |
---|---|---|
SearchInput | Required | Text |
Take | Required | Number |
Possible Response:
{
"usersCount": 0,
"groupsCount": 0,
"users": [
{
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.1928376Z",
"emailConfirmed": true
}
],
"groups": [
{
"imagePath": "an example string.",
"name": "an example string.",
"hasPassword": true,
"ownerId": "an example string.",
"id": 0,
"hasTimer": true,
"conversationCreateTime": "2023-10-01T22:26:05.1935188Z"
}
],
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
GET Discover friends
Request path:
https://server.kahla.app/Friendship/DiscoverFriends
Request example:
https://server.kahla.app/Friendship/DiscoverFriends?take=0
Request arguments:
Name | Required | Type |
---|---|---|
take | Not required | Number |
Possible Response:
{
"items": [
{
"commonFriends": 0,
"commonGroups": 0,
"sentRequest": true,
"targetUser": {
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.1970903Z",
"emailConfirmed": true
}
}
],
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
GET User detail
Request path:
https://server.kahla.app/Friendship/UserDetail
Request example:
https://server.kahla.app/Friendship/UserDetail?id=yourid
Request arguments:
Name | Required | Type |
---|---|---|
id | Required | Text |
Possible Response:
{
"user": {
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.2010665Z",
"emailConfirmed": true
},
"areFriends": true,
"sentRequest": true,
"pendingRequest": {
"id": 0,
"creatorId": "an example string.",
"creator": {
"markEmailPublic": true,
"themeId": 0,
"email": "an example string.",
"enableEmailNotification": true,
"enableEnterToSendMessage": true,
"enableInvisiable": true,
"listInSearchResult": true,
"isOnline": true,
"id": "an example string.",
"bio": "an example string.",
"nickName": "an example string.",
"sex": "an example string.",
"iconFilePath": "an example string.",
"preferedLanguage": "an example string.",
"accountCreateTime": "2023-10-01T22:26:05.2021769Z",
"emailConfirmed": true
},
"targetId": "an example string.",
"createTime": "2023-10-01T22:26:05.2024758Z",
"completed": true
},
"conversationId": 0,
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Report him
Request path:
https://server.kahla.app/Friendship/ReportHim
Request example:
https://server.kahla.app/Friendship/ReportHim?TargetUserId=yourTargetUserId&Reason=yourReason
Request content type:
application/x-www-form-urlencoded
Form content example:
TargetUserId=yourTargetUserId&Reason=yourReason
Request form:
Name | Required | Type |
---|---|---|
TargetUserId | Required | Text |
Reason | Required | Text |
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}