Trendsic Platform Service

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}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class Department implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DepartmentID=0,
        /** @var string */
        public string $DepartmentUID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Color=null,
        /** @var float */
        public float $Budget=0.0,
        /** @var string|null */
        public ?string $BillingMethod=null,
        /** @var string|null */
        public ?string $CostCenter=null,
        /** @var string|null */
        public ?string $BillingContact=null,
        /** @var string|null */
        public ?string $BillingEmail=null,
        /** @var bool|null */
        public ?bool $ApprovalOn=null,
        /** @var float */
        public float $Threshold=0.0,
        /** @var bool|null */
        public ?bool $Active=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime */
        public DateTime $CreatedAt=new DateTime(),
        /** @var int */
        public int $Members=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DepartmentID'])) $this->DepartmentID = $o['DepartmentID'];
        if (isset($o['DepartmentUID'])) $this->DepartmentUID = $o['DepartmentUID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['Budget'])) $this->Budget = $o['Budget'];
        if (isset($o['BillingMethod'])) $this->BillingMethod = $o['BillingMethod'];
        if (isset($o['CostCenter'])) $this->CostCenter = $o['CostCenter'];
        if (isset($o['BillingContact'])) $this->BillingContact = $o['BillingContact'];
        if (isset($o['BillingEmail'])) $this->BillingEmail = $o['BillingEmail'];
        if (isset($o['ApprovalOn'])) $this->ApprovalOn = $o['ApprovalOn'];
        if (isset($o['Threshold'])) $this->Threshold = $o['Threshold'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['Members'])) $this->Members = $o['Members'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DepartmentID)) $o['DepartmentID'] = $this->DepartmentID;
        if (isset($this->DepartmentUID)) $o['DepartmentUID'] = $this->DepartmentUID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->Budget)) $o['Budget'] = $this->Budget;
        if (isset($this->BillingMethod)) $o['BillingMethod'] = $this->BillingMethod;
        if (isset($this->CostCenter)) $o['CostCenter'] = $this->CostCenter;
        if (isset($this->BillingContact)) $o['BillingContact'] = $this->BillingContact;
        if (isset($this->BillingEmail)) $o['BillingEmail'] = $this->BillingEmail;
        if (isset($this->ApprovalOn)) $o['ApprovalOn'] = $this->ApprovalOn;
        if (isset($this->Threshold)) $o['Threshold'] = $this->Threshold;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->Members)) $o['Members'] = $this->Members;
        return empty($o) ? new class(){} : $o;
    }
}

class DepartmentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Department>|null */
        public ?array $Department=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Department'])) $this->Department = JsonConverters::fromArray('Department', $o['Department']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Department)) $o['Department'] = JsonConverters::toArray('Department', $this->Department);
        return empty($o) ? new class(){} : $o;
    }
}

class DepartmentRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DepartmentID=0,
        /** @var Department|null */
        public ?Department $Department=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DepartmentID'])) $this->DepartmentID = $o['DepartmentID'];
        if (isset($o['Department'])) $this->Department = JsonConverters::from('Department', $o['Department']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DepartmentID)) $o['DepartmentID'] = $this->DepartmentID;
        if (isset($this->Department)) $o['Department'] = JsonConverters::to('Department', $this->Department);
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>