Trendsic Platform Service

<back to all web services

ServiceAgreementRequest

Requires Authentication
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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ServiceAgreement
    {
        public virtual int AgreementID { get; set; }
        public virtual Guid AgreementUID { get; set; }
        public virtual Guid TenantId { get; set; }
        public virtual Guid BranchId { get; set; }
        public virtual string BranchName { get; set; }
        public virtual int ProjectID { get; set; }
        public virtual string ProjectName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Status { get; set; }
        public virtual string PricingShape { get; set; }
        public virtual decimal? MonthlyAmount { get; set; }
        public virtual decimal? PerVisitAmount { get; set; }
        public virtual string SkipPolicy { get; set; }
        public virtual int? SeasonStartMonth { get; set; }
        public virtual int? SeasonStartDay { get; set; }
        public virtual int? SeasonEndMonth { get; set; }
        public virtual int? SeasonEndDay { get; set; }
        public virtual string RecurrenceFrequency { get; set; }
        public virtual string RecurrenceBy { get; set; }
        public virtual string RecurrenceByValue { get; set; }
        public virtual DateTime? EffectiveStartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        public virtual int? PreferredCrewID { get; set; }
        public virtual string PreferredCrewName { get; set; }
        public virtual string ExternalRef { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual string UpdatedBy { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
        public virtual DateTime? NextVisitDate { get; set; }
        public virtual int VisitsThisPeriod { get; set; }
    }

    public partial class ServiceAgreementRequest
    {
        public virtual int AgreementID { get; set; }
        public virtual int ProjectID { get; set; }
        public virtual List<ServiceAgreement> ServiceAgreement { get; set; } = [];
    }

    public partial class ServiceAgreementResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<ServiceAgreement> ServiceAgreement { get; set; } = [];
    }

}

C# ServiceAgreementRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementID: 0,
	ProjectID: 0,
	ServiceAgreement: 
	[
		{
			AgreementID: 0,
			AgreementUID: 00000000000000000000000000000000,
			TenantId: 00000000000000000000000000000000,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			ProjectID: 0,
			ProjectName: String,
			Name: String,
			Status: String,
			PricingShape: String,
			MonthlyAmount: 0,
			PerVisitAmount: 0,
			SkipPolicy: String,
			SeasonStartMonth: 0,
			SeasonStartDay: 0,
			SeasonEndMonth: 0,
			SeasonEndDay: 0,
			RecurrenceFrequency: String,
			RecurrenceBy: String,
			RecurrenceByValue: String,
			EffectiveStartDate: 0001-01-01,
			EndDate: 0001-01-01,
			PreferredCrewID: 0,
			PreferredCrewName: String,
			ExternalRef: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			NextVisitDate: 0001-01-01,
			VisitsThisPeriod: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ServiceAgreement: 
	[
		{
			AgreementID: 0,
			AgreementUID: 00000000000000000000000000000000,
			TenantId: 00000000000000000000000000000000,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			ProjectID: 0,
			ProjectName: String,
			Name: String,
			Status: String,
			PricingShape: String,
			MonthlyAmount: 0,
			PerVisitAmount: 0,
			SkipPolicy: String,
			SeasonStartMonth: 0,
			SeasonStartDay: 0,
			SeasonEndMonth: 0,
			SeasonEndDay: 0,
			RecurrenceFrequency: String,
			RecurrenceBy: String,
			RecurrenceByValue: String,
			EffectiveStartDate: 0001-01-01,
			EndDate: 0001-01-01,
			PreferredCrewID: 0,
			PreferredCrewName: String,
			ExternalRef: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			NextVisitDate: 0001-01-01,
			VisitsThisPeriod: 0
		}
	]
}