| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/customercheckins/{Id}/notes/{NoteId}/done |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerNote:
note_id: int = 0
scope: Optional[str] = None
text: Optional[str] = None
is_priority: bool = False
created_by_user_id: Optional[str] = None
created_by_name: Optional[str] = None
created_at: Optional[datetime.datetime] = None
done_at: Optional[datetime.datetime] = None
is_carry: bool = False
shown_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerNoteResponse:
response_status: Optional[ResponseStatus] = None
notes: List[CustomerNote] = field(default_factory=list)
carry: List[CustomerNote] = field(default_factory=list)
can_priority: bool = False
note: Optional[CustomerNote] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerNoteDoneRequest:
id: Optional[str] = None
note_id: int = 0
Python CustomerNoteDoneRequest 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/{NoteId}/done HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 00000000000000000000000000000000,
NoteId: 0
}
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
}
}