| Required roles: | Administrator, Administrator, Administrator |
| GET,PUT,OPTIONS | /v1/NewAgent/{AgentId} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/NewAgent |
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 NewAgent:
agent_id: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
user_name: Optional[str] = None
email: Optional[str] = None
is_admin: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewAgentResponse:
response_status: Optional[ResponseStatus] = None
new_agent: List[NewAgent] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewAgentRequest:
agent_id: int = 0
new_agent: List[NewAgent] = field(default_factory=list)
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/NewAgent HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NewAgentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentId>0</AgentId>
<NewAgent>
<NewAgent>
<AgentId>0</AgentId>
<Email>String</Email>
<FirstName>String</FirstName>
<IsAdmin>false</IsAdmin>
<LastName>String</LastName>
<UserName>String</UserName>
</NewAgent>
</NewAgent>
</NewAgentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NewAgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<NewAgent>
<NewAgent>
<AgentId>0</AgentId>
<Email>String</Email>
<FirstName>String</FirstName>
<IsAdmin>false</IsAdmin>
<LastName>String</LastName>
<UserName>String</UserName>
</NewAgent>
</NewAgent>
<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>
</NewAgentResponse>