| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,POST,OPTIONS | /v1/customercheckins/{Id}/notes |
|---|
import Foundation
import ServiceStack
public class CustomerNotesRequest : Codable
{
public var id:String
public var text:String
public var scope:String
public var isPriority:Bool
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 CustomerNotesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 00000000000000000000000000000000,
Text: String,
Scope: String,
IsPriority: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
DoneAt: 0001-01-01,
IsCarry: False,
ShownAt: 0001-01-01
}
],
Carry:
[
{
NoteId: 0,
Scope: String,
Text: String,
IsPriority: False,
CreatedByUserId: 00000000000000000000000000000000,
CreatedByName: String,
CreatedAt: 0001-01-01,
DoneAt: 0001-01-01,
IsCarry: False,
ShownAt: 0001-01-01
}
],
CanPriority: False,
Note:
{
NoteId: 0,
Scope: String,
Text: String,
IsPriority: False,
CreatedByUserId: 00000000000000000000000000000000,
CreatedByName: String,
CreatedAt: 0001-01-01,
DoneAt: 0001-01-01,
IsCarry: False,
ShownAt: 0001-01-01
}
}