Trendsic Platform Service

<back to all web services

CustomerNoteDeleteRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/customercheckins/{Id}/notes/{NoteId}
import Foundation
import ServiceStack

public class CustomerNoteDeleteRequest : Codable
{
    public var id:String
    public var noteId:Int

    required public init(){}
}

public class CustomerNoteResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var notes:[CustomerNote] = []
    public var carry:[CustomerNote] = []
    public var canPriority:Bool
    public var note:CustomerNote

    required public init(){}
}

public class CustomerNote : Codable
{
    public var noteId:Int
    public var scope:String
    public var text:String
    public var isPriority:Bool
    public var createdByUserId:String?
    public var createdByName:String
    public var createdAt:Date?
    public var doneAt:Date?
    public var isCarry:Bool
    public var shownAt:Date?

    required public init(){}
}


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

DELETE /v1/customercheckins/{Id}/notes/{NoteId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
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"}}