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
namespace CRM.AgencyPlatform.API.Internal

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

    [<AllowNullLiteral>]
    type CustomerNote() = 
        member val NoteId:Int32 = new Int32() with get,set
        member val Scope:String = null with get,set
        member val Text:String = null with get,set
        member val IsPriority:Boolean = new Boolean() with get,set
        member val CreatedByUserId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val CreatedByName:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DoneAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsCarry:Boolean = new Boolean() with get,set
        member val ShownAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CustomerNoteResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Notes:ResizeArray<CustomerNote> = new ResizeArray<CustomerNote>() with get,set
        member val Carry:ResizeArray<CustomerNote> = new ResizeArray<CustomerNote>() with get,set
        member val CanPriority:Boolean = new Boolean() with get,set
        member val Note:CustomerNote = null with get,set

    [<AllowNullLiteral>]
    type CustomerNotesRequest() = 
        member val Id:Guid = new Guid() with get,set
        member val Text:String = null with get,set
        member val Scope:String = null with get,set
        member val IsPriority:Boolean = new Boolean() with get,set

F# CustomerNotesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Id":"00000000000000000000000000000000","Text":"String","Scope":"String","IsPriority":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}