• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

GET ChatTopic/{id}/UserAgent/{username}

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read
GET /api/v1/ChatTopic/{chatTopicId}/UserAgent/{username}

Get a user assigned to a topic

Path Part Type Description
chatTopicId int32 Id of the chat topic Required
username string Associate username or associate id to get. Required

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: ChatTopicAgent

Property Name Type Description
TopicId int32 The reference to the associated chat topic.
User Associate The associate that is the user agent.
CanListen bool True of a user can listen in on this topic
CanRespond bool True if the user can respond to chats in this topic
CanManage bool True if the user is a manager for this topic
CanNotify bool True if the user should receive notifications for this topic

Sample request

GET /api/v1/ChatTopic/{chatTopicId}/UserAgent/{username}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "TopicId": 568,
  "User": null,
  "CanListen": false,
  "CanRespond": true,
  "CanManage": false,
  "CanNotify": false
}
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top