Trendsic Platform Service

<back to all web services

LinesRequest

Requires Authentication
Required roles:Administrator, Administrator, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Lines/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/LinesByLocationId/{LocationId}
GET,POST,PUT,DELETE,OPTIONS/v1/Lines
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 LineImage:
    image_id: Optional[str] = None
    file_name: Optional[str] = None
    image_title: Optional[str] = None
    upload_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Line:
    id: Optional[str] = None
    location_id: Optional[str] = None
    location_name: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    service_duration_minutes: int = 0
    wait_time: int = 0
    cost: Decimal = decimal.Decimal(0)
    upper_threshold: Optional[int] = None
    lower_threshold: Optional[int] = None
    active: bool = False
    ent_date: Optional[datetime.datetime] = None
    mod_date: Optional[datetime.datetime] = None
    send_questionnaire: bool = False
    require_upload: bool = False
    upload_message: Optional[str] = None
    line_images: List[LineImage] = field(default_factory=list)


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinesRequest:
    id: Optional[str] = None
    location_id: Optional[str] = None
    lines: List[Line] = field(default_factory=list)

Python LinesRequest 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/Lines/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LinesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Lines>
    <Line>
      <Active>false</Active>
      <Cost>0</Cost>
      <Description>String</Description>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <LineImages>
        <LineImage>
          <FileName>String</FileName>
          <ImageId>00000000-0000-0000-0000-000000000000</ImageId>
          <ImageTitle>String</ImageTitle>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
        </LineImage>
      </LineImages>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <LocationName>String</LocationName>
      <LowerThreshold>0</LowerThreshold>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <RequireUpload>false</RequireUpload>
      <SendQuestionnaire>false</SendQuestionnaire>
      <ServiceDurationMinutes>0</ServiceDurationMinutes>
      <UploadMessage>String</UploadMessage>
      <UpperThreshold>0</UpperThreshold>
      <WaitTime>0</WaitTime>
    </Line>
  </Lines>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
</LinesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LinesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Lines>
    <Line>
      <Active>false</Active>
      <Cost>0</Cost>
      <Description>String</Description>
      <EntDate>0001-01-01T00:00:00</EntDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <LineImages>
        <LineImage>
          <FileName>String</FileName>
          <ImageId>00000000-0000-0000-0000-000000000000</ImageId>
          <ImageTitle>String</ImageTitle>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
        </LineImage>
      </LineImages>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <LocationName>String</LocationName>
      <LowerThreshold>0</LowerThreshold>
      <ModDate>0001-01-01T00:00:00</ModDate>
      <Name>String</Name>
      <RequireUpload>false</RequireUpload>
      <SendQuestionnaire>false</SendQuestionnaire>
      <ServiceDurationMinutes>0</ServiceDurationMinutes>
      <UploadMessage>String</UploadMessage>
      <UpperThreshold>0</UpperThreshold>
      <WaitTime>0</WaitTime>
    </Line>
  </Lines>
  <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>
</LinesResponse>