Friendship

Catalog


GET Authorize Mine

Request path:

https://staging.server.kahla.app/Friendship/MineTry

Request example:

https://staging.server.kahla.app/Friendship/Mine

Possible Response:

{
  "users": [
    {
      "makeEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.9804732Z",
      "emailConfirmed": true
    }
  ],
  "groups": [
    {
      "imagePath": "an example string.",
      "name": "an example string.",
      "hasPassword": true,
      "ownerId": "an example string.",
      "id": 0,
      "hasTimer": true,
      "conversationCreateTime": "2019-11-18T21:00:45.9806657Z"
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Authorize Delete friend

Request path:

https://staging.server.kahla.app/Friendship/DeleteFriend

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."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Authorize Create request

Request path:

https://staging.server.kahla.app/Friendship/CreateRequest

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."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Authorize Complete request

Request path:

https://staging.server.kahla.app/Friendship/CompleteRequest

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:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Authorize My requests

Request path:

https://staging.server.kahla.app/Friendship/MyRequestsTry

Request example:

https://staging.server.kahla.app/Friendship/MyRequests

Possible Response:

{
  "items": [
    {
      "id": 0,
      "creatorId": "an example string.",
      "creator": {
        "makeEmailPublic": true,
        "themeId": 0,
        "email": "an example string.",
        "enableEmailNotification": true,
        "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.9830736Z",
        "emailConfirmed": true
      },
      "targetId": "an example string.",
      "createTime": "2019-11-18T21:00:45.9832033Z",
      "completed": true
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Authorize Search everything

Request path:

https://staging.server.kahla.app/Friendship/SearchEverythingTry

Request example:

https://staging.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": [
    {
      "makeEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.9842711Z",
      "emailConfirmed": true
    }
  ],
  "groups": [
    {
      "imagePath": "an example string.",
      "name": "an example string.",
      "hasPassword": true,
      "ownerId": "an example string.",
      "id": 0,
      "hasTimer": true,
      "conversationCreateTime": "2019-11-18T21:00:45.984443Z"
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Authorize Discover friends

Request path:

https://staging.server.kahla.app/Friendship/DiscoverFriendsTry

Request example:

https://staging.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": {
        "makeEmailPublic": true,
        "themeId": 0,
        "email": "an example string.",
        "enableEmailNotification": true,
        "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.986641Z",
        "emailConfirmed": true
      }
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Authorize User detail

Request path:

https://staging.server.kahla.app/Friendship/UserDetailTry

Request example:

https://staging.server.kahla.app/Friendship/UserDetail?id=yourid

Request arguments:

Name Required Type
id Required Text

Possible Response:

{
  "user": {
    "makeEmailPublic": true,
    "themeId": 0,
    "email": "an example string.",
    "enableEmailNotification": true,
    "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.987782Z",
    "emailConfirmed": true
  },
  "areFriends": true,
  "sentRequest": true,
  "pendingRequest": {
    "id": 0,
    "creatorId": "an example string.",
    "creator": {
      "makeEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": 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": "2019-11-18T21:00:45.9887885Z",
      "emailConfirmed": true
    },
    "targetId": "an example string.",
    "createTime": "2019-11-18T21:00:45.9889153Z",
    "completed": true
  },
  "conversationId": 0,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Authorize Report him

Request path:

https://staging.server.kahla.app/Friendship/ReportHim

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."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}