Trendsic Platform Service

ServiceAgreementRequest

The following routes are available for this service:
GET,OPTIONS	/v1/project/{ProjectID}/agreements
GET,POST,PUT,DELETE,OPTIONS	/v1/serviceagreement
GET,DELETE,OPTIONS	/v1/serviceagreement/{AgreementID}

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 ServiceAgreement:
    agreement_i_d: int = 0
    agreement_u_i_d: Optional[str] = None
    tenant_id: Optional[str] = None
    branch_id: Optional[str] = None
    branch_name: Optional[str] = None
    project_i_d: int = 0
    project_name: Optional[str] = None
    name: Optional[str] = None
    status: Optional[str] = None
    pricing_shape: Optional[str] = None
    monthly_amount: Optional[Decimal] = None
    per_visit_amount: Optional[Decimal] = None
    skip_policy: Optional[str] = None
    season_start_month: Optional[int] = None
    season_start_day: Optional[int] = None
    season_end_month: Optional[int] = None
    season_end_day: Optional[int] = None
    recurrence_frequency: Optional[str] = None
    recurrence_by: Optional[str] = None
    recurrence_by_value: Optional[str] = None
    effective_start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    preferred_crew_i_d: Optional[int] = None
    preferred_crew_name: Optional[str] = None
    external_ref: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_by: Optional[str] = None
    updated_at: Optional[datetime.datetime] = None
    next_visit_date: Optional[datetime.datetime] = None
    visits_this_period: int = 0


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceAgreementRequest:
    agreement_i_d: int = 0
    project_i_d: int = 0
    service_agreement: List[ServiceAgreement] = field(default_factory=list)

Python ServiceAgreementRequest 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/serviceagreement HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ServiceAgreementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementID>0</AgreementID>
  <ProjectID>0</ProjectID>
  <ServiceAgreement>
    <ServiceAgreement>
      <AgreementID>0</AgreementID>
      <AgreementUID>00000000-0000-0000-0000-000000000000</AgreementUID>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EffectiveStartDate>0001-01-01T00:00:00</EffectiveStartDate>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <ExternalRef>String</ExternalRef>
      <MonthlyAmount>0</MonthlyAmount>
      <Name>String</Name>
      <NextVisitDate>0001-01-01T00:00:00</NextVisitDate>
      <PerVisitAmount>0</PerVisitAmount>
      <PreferredCrewID>0</PreferredCrewID>
      <PreferredCrewName>String</PreferredCrewName>
      <PricingShape>String</PricingShape>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <RecurrenceBy>String</RecurrenceBy>
      <RecurrenceByValue>String</RecurrenceByValue>
      <RecurrenceFrequency>String</RecurrenceFrequency>
      <SeasonEndDay>0</SeasonEndDay>
      <SeasonEndMonth>0</SeasonEndMonth>
      <SeasonStartDay>0</SeasonStartDay>
      <SeasonStartMonth>0</SeasonStartMonth>
      <SkipPolicy>String</SkipPolicy>
      <Status>String</Status>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
      <VisitsThisPeriod>0</VisitsThisPeriod>
    </ServiceAgreement>
  </ServiceAgreement>
</ServiceAgreementRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceAgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <ServiceAgreement>
    <ServiceAgreement>
      <AgreementID>0</AgreementID>
      <AgreementUID>00000000-0000-0000-0000-000000000000</AgreementUID>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EffectiveStartDate>0001-01-01T00:00:00</EffectiveStartDate>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <ExternalRef>String</ExternalRef>
      <MonthlyAmount>0</MonthlyAmount>
      <Name>String</Name>
      <NextVisitDate>0001-01-01T00:00:00</NextVisitDate>
      <PerVisitAmount>0</PerVisitAmount>
      <PreferredCrewID>0</PreferredCrewID>
      <PreferredCrewName>String</PreferredCrewName>
      <PricingShape>String</PricingShape>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <RecurrenceBy>String</RecurrenceBy>
      <RecurrenceByValue>String</RecurrenceByValue>
      <RecurrenceFrequency>String</RecurrenceFrequency>
      <SeasonEndDay>0</SeasonEndDay>
      <SeasonEndMonth>0</SeasonEndMonth>
      <SeasonStartDay>0</SeasonStartDay>
      <SeasonStartMonth>0</SeasonStartMonth>
      <SkipPolicy>String</SkipPolicy>
      <Status>String</Status>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
      <VisitsThisPeriod>0</VisitsThisPeriod>
    </ServiceAgreement>
  </ServiceAgreement>
</ServiceAgreementResponse>