BokaMera.API.Host

<back to all web services

CreateCustomerComments

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/customers/{CustomerId}/commentsAdd a customers commentsGet all connected customer comments for the company.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CustomerCommentsResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val CustomerId:Guid = new Guid() with get,set
        member val Comments:String = null with get,set
        member val Updated:DateTime = new DateTime() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val ImageUrl:Uri = null with get,set

    [<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")>]
    [<AllowNullLiteral>]
    type CreateCustomerComments() = 
        [<ApiMember(IsRequired=true, ParameterType="path")>]
        member val CustomerId:Guid = new Guid() with get,set

        [<ApiMember(IsRequired=true)>]
        member val Comments:String = null with get,set

        [<ApiMember>]
        member val ImageUrl:Uri = null with get,set

        [<ApiMember>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# CreateCustomerComments 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 /customers/{CustomerId}/comments HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<CustomerCommentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Comments>String</Comments>
  <Created>0001-01-01T00:00:00</Created>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <Id>0</Id>
  <ImageUrl i:nil="true" />
  <Updated>0001-01-01T00:00:00</Updated>
</CustomerCommentsResponse>