Trendsic Platform Service

<back to all web services

DispatchPatternRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/pattern
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 DispatchModuleView:
    key: Optional[str] = None
    mode: Optional[str] = None
    allowed: bool = False
    enabled: bool = False
    in_flight: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPatternView:
    pattern_id: Optional[str] = None
    name: Optional[str] = None
    source: Optional[str] = None
    facility: Optional[str] = None
    unit: Optional[str] = None
    has_quotas: bool = False
    is_inverted: bool = False
    load_limit_mins: int = 0
    ticket_source: Optional[str] = None
    pay_basis: Optional[str] = None
    is_active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchModulesResponse:
    modules: List[DispatchModuleView] = field(default_factory=list)
    patterns: List[DispatchPatternView] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPatternRequest:
    pattern_id: Optional[str] = None

Python DispatchPatternRequest 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.

PUT /v1/dispatch/settings/pattern HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchPatternRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PatternId>String</PatternId>
</DispatchPatternRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchModulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Modules>
    <DispatchModuleView>
      <Allowed>false</Allowed>
      <Enabled>false</Enabled>
      <InFlight>0</InFlight>
      <Key>String</Key>
      <Mode>String</Mode>
    </DispatchModuleView>
  </Modules>
  <Patterns>
    <DispatchPatternView>
      <Facility>String</Facility>
      <HasQuotas>false</HasQuotas>
      <IsActive>false</IsActive>
      <IsInverted>false</IsInverted>
      <LoadLimitMins>0</LoadLimitMins>
      <Name>String</Name>
      <PatternId>String</PatternId>
      <PayBasis>String</PayBasis>
      <Source>String</Source>
      <TicketSource>String</TicketSource>
      <Unit>String</Unit>
    </DispatchPatternView>
  </Patterns>
  <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>
</DispatchModulesResponse>