Trendsic Platform Service

AgreementExpiringRequest

The following routes are available for this service:
GET,OPTIONS	/v1/serviceagreement/expiring

**AgreementExpiringRequest** Parameters:
Name	Parameter	Data Type	Required	Description
WithinDays	query	int	No

**ServiceAgreementResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
ServiceAgreement	form	List<ServiceAgreement>	No

**ServiceAgreement** Parameters:
Name	Parameter	Data Type	Required
AgreementID	form	int	No
AgreementUID	form	Guid	No
TenantId	form	Guid	No
BranchId	form	Guid	No
BranchName	form	string	No
ProjectID	form	int	No
ProjectName	form	string	No
ProjectLocationID	form	int?	No
ProjectLocationName	form	string	No
Name	form	string	No
Status	form	string	No
PricingShape	form	string	No
MonthlyAmount	form	decimal?	No
PerVisitAmount	form	decimal?	No
SkipPolicy	form	string	No
SeasonStartMonth	form	int?	No
SeasonStartDay	form	int?	No
SeasonEndMonth	form	int?	No
SeasonEndDay	form	int?	No
RecurrenceFrequency	form	string	No
RecurrenceBy	form	string	No
RecurrenceByValue	form	string	No
RecurrenceInterval	form	int?	No
WeeklyDayMode	form	string	No
EffectiveStartDate	form	DateTime?	No
EndDate	form	DateTime?	No
CompletionAnchored	form	bool?	No
PreferredCrewID	form	int?	No
PreferredCrewName	form	string	No
BackingJobID	form	int?	No
ExternalRef	form	string	No
EstimatedDurationMinutes	form	int?	No
ActualDurationMinutes	form	int?	No
CreatedBy	form	string	No
CreatedAt	form	DateTime?	No
UpdatedBy	form	string	No
UpdatedAt	form	DateTime?	No
NextVisitDate	form	DateTime?	No
VisitsThisPeriod	form	int	No

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.

GET /v1/serviceagreement/expiring HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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,
			ProjectLocationID: 0,
			ProjectLocationName: 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,
			RecurrenceInterval: 0,
			WeeklyDayMode: String,
			EffectiveStartDate: 0001-01-01,
			EndDate: 0001-01-01,
			CompletionAnchored: False,
			PreferredCrewID: 0,
			PreferredCrewName: String,
			BackingJobID: 0,
			ExternalRef: String,
			EstimatedDurationMinutes: 0,
			ActualDurationMinutes: 0,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			NextVisitDate: 0001-01-01,
			VisitsThisPeriod: 0
		}
	]
}