| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/Reminder/{ReminderId} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/Reminder |
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 Reminder:
reminder_id: Optional[str] = None
table_name: Optional[str] = None
field_name: Optional[str] = None
record_id: int = 0
reminder_date: datetime.datetime = datetime.datetime(1, 1, 1)
reminder_note: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
created_by: Optional[str] = None
completed_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReminderExtended(Reminder):
agent_name: Optional[str] = None
record_agent_name: Optional[str] = None
record_agent_i_d: int = 0
is_admin: bool = False
agent_i_d: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReminderResponse:
response_status: Optional[ResponseStatus] = None
reminder: List[ReminderExtended] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReminderRequest:
reminder: List[ReminderExtended] = field(default_factory=list)
reminder_id: Optional[str] = None
remind_owner: bool = False
agent_name: Optional[str] = None
ccavp: bool = False
is_admin_reminder: bool = False
admin_agent_id: int = 0
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/Reminder HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Reminder:
[
{
AgentName: String,
RecordAgentName: String,
RecordAgentID: 0,
IsAdmin: False,
AgentID: 0,
ReminderId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
ReminderDate: 0001-01-01,
ReminderNote: String,
CreatedDate: 0001-01-01,
CreatedBy: String,
CompletedDate: 0001-01-01
}
],
ReminderId: 00000000000000000000000000000000,
RemindOwner: False,
AgentName: String,
CCAVP: False,
IsAdminReminder: False,
AdminAgentId: 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
}
},
Reminder:
[
{
AgentName: String,
RecordAgentName: String,
RecordAgentID: 0,
IsAdmin: False,
AgentID: 0,
ReminderId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
ReminderDate: 0001-01-01,
ReminderNote: String,
CreatedDate: 0001-01-01,
CreatedBy: String,
CompletedDate: 0001-01-01
}
]
}