BokaMera.API.Host

CommentsSuperAdminUserQuery

**Requires Authentication**
Required role:	superadmin

The following routes are available for this service:
GET	/superadmin/company/{CompanyId}/comments	Get companies comments.

import Foundation
import ServiceStack

// @ApiResponse(Description="", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
public class CommentsSuperAdminUserQuery : QueryDb2<CompanyComment, CompanyCommentsResponse>
{
    /**
    * Enter the companyId for the customer
    */
    // @ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
    public var companyId:String?

    // @ApiMember()
    public var commentsTypeId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
        case commentsTypeId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        commentsTypeId = try container.decodeIfPresent(Int.self, forKey: .commentsTypeId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if commentsTypeId != nil { try container.encode(commentsTypeId, forKey: .commentsTypeId) }
    }
}

public class CompanyComment : BaseModel
{
    public var commentsType:CommentsType
    // @Required()
    public var companyId:String?

    public var id:Int
    public var commentsTypeId:Int
    public var comments:String
    public var createdBy:String
    // @Required()
    public var created:Date?

    // @Required()
    public var updated:Date?

    public var modifiedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case commentsType
        case companyId
        case id
        case commentsTypeId
        case comments
        case createdBy
        case created
        case updated
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        commentsType = try container.decodeIfPresent(CommentsType.self, forKey: .commentsType)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        commentsTypeId = try container.decodeIfPresent(Int.self, forKey: .commentsTypeId)
        comments = try container.decodeIfPresent(String.self, forKey: .comments)
        createdBy = try container.decodeIfPresent(String.self, forKey: .createdBy)
        created = try container.decodeIfPresent(Date.self, forKey: .created)
        updated = try container.decodeIfPresent(Date.self, forKey: .updated)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if commentsType != nil { try container.encode(commentsType, forKey: .commentsType) }
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if id != nil { try container.encode(id, forKey: .id) }
        if commentsTypeId != nil { try container.encode(commentsTypeId, forKey: .commentsTypeId) }
        if comments != nil { try container.encode(comments, forKey: .comments) }
        if createdBy != nil { try container.encode(createdBy, forKey: .createdBy) }
        if created != nil { try container.encode(created, forKey: .created) }
        if updated != nil { try container.encode(updated, forKey: .updated) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class BaseModel : Codable
{
    required public init(){}
}

public class CommentsType : BaseModel
{
    public var id:Int
    public var name:String
    public var Description:String
    public var modifiedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case name
        case Description
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        Description = try container.decodeIfPresent(String.self, forKey: .Description)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if name != nil { try container.encode(name, forKey: .name) }
        if Description != nil { try container.encode(Description, forKey: .Description) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class CompanyCommentsResponse : Codable
{
    // @ApiMember()
    public var companyId:String?

    // @ApiMember()
    public var id:Int

    // @ApiMember(IsRequired=true)
    public var comment:String

    // @ApiMember(IsRequired=true)
    public var commentTypeId:CommentsType

    // @ApiMember(IsRequired=true)
    public var commentType:CommentsTypeResponse

    /**
    * The updated date
    */
    // @ApiMember(Description="The updated date")
    public var updated:Date

    /**
    * The created date
    */
    // @ApiMember(Description="The created date")
    public var created:Date

    /**
    * The created by
    */
    // @ApiMember(Description="The created by")
    public var createdBy:String

    required public init(){}
}

public enum CommentsType : Int, Codable
{
    case NormalComment = 1
    case CallBackPhoneComment = 2
    case CallBackEmailComment = 3
    case CallBackMeetingBookedComment = 4
    case CallBackNotInterestedComment = 5
}

public class CommentsTypeResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}

Swift CommentsSuperAdminUserQuery 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.

GET /superadmin/company/{CompanyId}/comments HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCompanyCommentsResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:CompanyCommentsResponse>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:CommentType>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:CommentType>
      <d2p1:CommentTypeId>NormalComment</d2p1:CommentTypeId>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
    </d2p1:CompanyCommentsResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCompanyCommentsResponseWg5EthtI>