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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ServiceAgreement() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val AgreementUID:Guid = new Guid() with get,set
        member val TenantId:Guid = new Guid() with get,set
        member val BranchId:Guid = new Guid() with get,set
        member val BranchName:String = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectName:String = null with get,set
        member val Name:String = null with get,set
        member val Status:String = null with get,set
        member val PricingShape:String = null with get,set
        member val MonthlyAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PerVisitAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val SkipPolicy:String = null with get,set
        member val SeasonStartMonth:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SeasonStartDay:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SeasonEndMonth:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SeasonEndDay:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RecurrenceFrequency:String = null with get,set
        member val RecurrenceBy:String = null with get,set
        member val RecurrenceByValue:String = null with get,set
        member val EffectiveStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PreferredCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PreferredCrewName:String = null with get,set
        member val ExternalRef:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedBy:String = null with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val NextVisitDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val VisitsThisPeriod:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ServiceAgreementResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ServiceAgreement:ResizeArray<ServiceAgreement> = new ResizeArray<ServiceAgreement>() with get,set

    [<AllowNullLiteral>]
    type ServiceAgreementRequest() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val ServiceAgreement:ResizeArray<ServiceAgreement> = new ResizeArray<ServiceAgreement>() with get,set

F# 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
		}
	]
}