Trendsic Platform Service

<back to all web services

CustomerNotesRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/customercheckins/{Id}/notes
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CustomerNotesRequest
{
    open var Id:UUID? = null
    open var Text:String? = null
    open var Scope:String? = null
    open var IsPriority:Boolean? = null
}

open class CustomerNoteResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Notes:ArrayList<CustomerNote> = ArrayList<CustomerNote>()
    open var Carry:ArrayList<CustomerNote> = ArrayList<CustomerNote>()
    open var CanPriority:Boolean? = null
    open var Note:CustomerNote? = null
}

open class CustomerNote
{
    open var NoteId:Int? = null
    open var Scope:String? = null
    open var Text:String? = null
    open var IsPriority:Boolean? = null
    open var CreatedByUserId:UUID? = null
    open var CreatedByName:String? = null
    open var CreatedAt:Date? = null
    open var DoneAt:Date? = null
    open var IsCarry:Boolean? = null
    open var ShownAt:Date? = null
}

Kotlin CustomerNotesRequest DTOs

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

HTTP + OTHER

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

POST /v1/customercheckins/{Id}/notes HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Id":"00000000000000000000000000000000","Text":"String","Scope":"String","IsPriority":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notes":[{"NoteId":0,"Scope":"String","Text":"String","IsPriority":false,"CreatedByUserId":"00000000000000000000000000000000","CreatedByName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","DoneAt":"0001-01-01T00:00:00.0000000","IsCarry":false,"ShownAt":"0001-01-01T00:00:00.0000000"}],"Carry":[{"NoteId":0,"Scope":"String","Text":"String","IsPriority":false,"CreatedByUserId":"00000000000000000000000000000000","CreatedByName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","DoneAt":"0001-01-01T00:00:00.0000000","IsCarry":false,"ShownAt":"0001-01-01T00:00:00.0000000"}],"CanPriority":false,"Note":{"NoteId":0,"Scope":"String","Text":"String","IsPriority":false,"CreatedByUserId":"00000000000000000000000000000000","CreatedByName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","DoneAt":"0001-01-01T00:00:00.0000000","IsCarry":false,"ShownAt":"0001-01-01T00:00:00.0000000"}}