Trendsic Platform Service

<back to all web services

DepartmentRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Administrator, Administrator, Administrator
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/Department
GET,DELETE,OPTIONS/v1/Department/{DepartmentID}
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 Department:
    department_i_d: int = 0
    department_u_i_d: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    code: Optional[str] = None
    color: Optional[str] = None
    budget: Decimal = decimal.Decimal(0)
    billing_method: Optional[str] = None
    cost_center: Optional[str] = None
    billing_contact: Optional[str] = None
    billing_email: Optional[str] = None
    approval_on: bool = False
    threshold: Decimal = decimal.Decimal(0)
    active: bool = False
    created_by: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    members: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DepartmentResponse:
    response_status: Optional[ResponseStatus] = None
    department: List[Department] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DepartmentRequest:
    department_i_d: int = 0
    department: Optional[Department] = None

Python DepartmentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Department HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DepartmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Department>
    <Active>false</Active>
    <ApprovalOn>false</ApprovalOn>
    <BillingContact>String</BillingContact>
    <BillingEmail>String</BillingEmail>
    <BillingMethod>String</BillingMethod>
    <Budget>0</Budget>
    <Code>String</Code>
    <Color>String</Color>
    <CostCenter>String</CostCenter>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DepartmentID>0</DepartmentID>
    <DepartmentUID>00000000-0000-0000-0000-000000000000</DepartmentUID>
    <Description>String</Description>
    <Members>0</Members>
    <Name>String</Name>
    <Threshold>0</Threshold>
  </Department>
  <DepartmentID>0</DepartmentID>
</DepartmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DepartmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Department>
    <Department>
      <Active>false</Active>
      <ApprovalOn>false</ApprovalOn>
      <BillingContact>String</BillingContact>
      <BillingEmail>String</BillingEmail>
      <BillingMethod>String</BillingMethod>
      <Budget>0</Budget>
      <Code>String</Code>
      <Color>String</Color>
      <CostCenter>String</CostCenter>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DepartmentID>0</DepartmentID>
      <DepartmentUID>00000000-0000-0000-0000-000000000000</DepartmentUID>
      <Description>String</Description>
      <Members>0</Members>
      <Name>String</Name>
      <Threshold>0</Threshold>
    </Department>
  </Department>
  <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>
</DepartmentResponse>