GET | /customers/{CustomerId}/comments | Get the customers comments | Get all connected customer comments for the company. |
---|
import Foundation
import ServiceStack
// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CustomerCommentsQuery : QueryDb2<CustomerComment, CustomerCommentsResponse>, ICompany
{
// @ApiMember(IsRequired=true)
public var customerId:String
// @ApiMember(IsRequired=true)
public var companyId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case customerId
case companyId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
customerId = try container.decodeIfPresent(String.self, forKey: .customerId)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if customerId != nil { try container.encode(customerId, forKey: .customerId) }
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
}
}
public class CustomerComment : BaseModel
{
// @Required()
public var companyId:String?
public var id:Int
// @Required()
public var customerId:String?
// @Required()
public var comments:String?
// @Required()
public var updated:Date?
// @Required()
public var created:Date?
public var imageUrl:String
public var modifiedDate:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case customerId
case comments
case updated
case created
case imageUrl
case modifiedDate
}
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)
id = try container.decodeIfPresent(Int.self, forKey: .id)
customerId = try container.decodeIfPresent(String.self, forKey: .customerId)
comments = try container.decodeIfPresent(String.self, forKey: .comments)
updated = try container.decodeIfPresent(Date.self, forKey: .updated)
created = try container.decodeIfPresent(Date.self, forKey: .created)
imageUrl = try container.decodeIfPresent(String.self, forKey: .imageUrl)
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 companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if customerId != nil { try container.encode(customerId, forKey: .customerId) }
if comments != nil { try container.encode(comments, forKey: .comments) }
if updated != nil { try container.encode(updated, forKey: .updated) }
if created != nil { try container.encode(created, forKey: .created) }
if imageUrl != nil { try container.encode(imageUrl, forKey: .imageUrl) }
if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
public class CustomerCommentsResponse : Codable
{
public var id:Int
public var customerId:String
public var comments:String
public var updated:Date
public var created:Date
public var imageUrl:Uri
required public init(){}
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
Swift CustomerCommentsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{CustomerId}/comments HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfCustomerCommentsResponseWg5EthtI 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:CustomerCommentsResponse> <d2p1:Comments>String</d2p1:Comments> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:CustomerId>00000000-0000-0000-0000-000000000000</d2p1:CustomerId> <d2p1:Id>0</d2p1:Id> <d2p1:ImageUrl i:nil="true" /> <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated> </d2p1:CustomerCommentsResponse> </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> </QueryResponseOfCustomerCommentsResponseWg5EthtI>