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}


export class ServiceAgreement
{
    public AgreementID: number;
    public AgreementUID: string;
    public TenantId: string;
    public BranchId: string;
    public BranchName: string;
    public ProjectID: number;
    public ProjectName: string;
    public Name: string;
    public Status: string;
    public PricingShape: string;
    public MonthlyAmount?: number;
    public PerVisitAmount?: number;
    public SkipPolicy: string;
    public SeasonStartMonth?: number;
    public SeasonStartDay?: number;
    public SeasonEndMonth?: number;
    public SeasonEndDay?: number;
    public RecurrenceFrequency: string;
    public RecurrenceBy: string;
    public RecurrenceByValue: string;
    public EffectiveStartDate?: string;
    public EndDate?: string;
    public PreferredCrewID?: number;
    public PreferredCrewName: string;
    public ExternalRef: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedBy: string;
    public UpdatedAt?: string;
    public NextVisitDate?: string;
    public VisitsThisPeriod: number;

    public constructor(init?: Partial<ServiceAgreement>) { (Object as any).assign(this, init); }
}

export class ServiceAgreementResponse
{
    public ResponseStatus: ResponseStatus;
    public ServiceAgreement: ServiceAgreement[] = [];

    public constructor(init?: Partial<ServiceAgreementResponse>) { (Object as any).assign(this, init); }
}

export class ServiceAgreementRequest
{
    public AgreementID: number;
    public ProjectID: number;
    public ServiceAgreement: ServiceAgreement[] = [];

    public constructor(init?: Partial<ServiceAgreementRequest>) { (Object as any).assign(this, init); }
}

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