BokaMera.API.Host

<back to all web services

SuperAdminAddSupportCaseComment

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/superadmin/support/cases/{Id}/commentsAdd a new support case commentAdd a new support case comment to the support case with the prvoided id for the currently logged in user, only administrators are allowed to add support cases.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class SuperAdminAddSupportCaseComment
            Implements ISupportCase
            '''<Summary>
            '''Enter the company id, if blank company id and you are an admin, your company id will be used.
            '''</Summary>
            <ApiMember(Description:="Enter the company id, if blank company id and you are an admin, your company id will be used.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''The support case id
            '''</Summary>
            <ApiMember(Description:="The support case id", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The case comment.
            '''</Summary>
            <ApiMember(Description:="The case comment.")>
            Public Overridable Property Comment As String
        End Class

        Public Partial Class SupportCaseCommentsResponse
            '''<Summary>
            '''The case id
            '''</Summary>
            <ApiMember(Description:="The case id")>
            Public Overridable Property SupportCaseId As Integer

            '''<Summary>
            '''The comments id
            '''</Summary>
            <ApiMember(Description:="The comments id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The case comment
            '''</Summary>
            <ApiMember(Description:="The case comment")>
            Public Overridable Property Comment As String

            '''<Summary>
            '''The case comment created by
            '''</Summary>
            <ApiMember(Description:="The case comment created by")>
            Public Overridable Property CreatedBy As String

            '''<Summary>
            '''The case comment created date
            '''</Summary>
            <ApiMember(Description:="The case comment created date")>
            Public Overridable Property Created As Date
        End Class
    End Namespace
End Namespace

VB.NET SuperAdminAddSupportCaseComment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /superadmin/support/cases/{Id}/comments HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SuperAdminAddSupportCaseComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Comment>String</Comment>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>0</Id>
</SuperAdminAddSupportCaseComment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SupportCaseCommentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Comment>String</Comment>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <Id>0</Id>
  <SupportCaseId>0</SupportCaseId>
</SupportCaseCommentsResponse>