| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationHeader/{NotificationHeaderId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationHeader |
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 NotificationHeader:
notification_header_id: int = 0
subject: Optional[str] = None
status: Optional[str] = None
needs_close_approval: bool = False
is_deleted: bool = False
created_by: int = 0
date_created: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationHeaderResponse:
response_status: Optional[ResponseStatus] = None
notification_header: List[NotificationHeader] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationHeaderRequest:
notification_header: List[NotificationHeader] = field(default_factory=list)
Python NotificationHeaderRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/NotificationHeader/{NotificationHeaderId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NotificationHeaderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<NotificationHeader>
<NotificationHeader>
<CreatedBy>0</CreatedBy>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<IsDeleted>false</IsDeleted>
<NeedsCloseApproval>false</NeedsCloseApproval>
<NotificationHeaderId>0</NotificationHeaderId>
<Status>String</Status>
<Subject>String</Subject>
</NotificationHeader>
</NotificationHeader>
</NotificationHeaderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NotificationHeaderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<NotificationHeader>
<NotificationHeader>
<CreatedBy>0</CreatedBy>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<IsDeleted>false</IsDeleted>
<NeedsCloseApproval>false</NeedsCloseApproval>
<NotificationHeaderId>0</NotificationHeaderId>
<Status>String</Status>
<Subject>String</Subject>
</NotificationHeader>
</NotificationHeader>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</NotificationHeaderResponse>