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}
import Foundation
import ServiceStack

public class ServiceAgreementRequest : Codable
{
    public var agreementID:Int
    public var projectID:Int
    public var serviceAgreement:[ServiceAgreement] = []

    required public init(){}
}

public class ServiceAgreement : Codable
{
    public var agreementID:Int
    public var agreementUID:String
    public var tenantId:String
    public var branchId:String
    public var branchName:String
    public var projectID:Int
    public var projectName:String
    public var name:String
    public var status:String
    public var pricingShape:String
    public var monthlyAmount:Double?
    public var perVisitAmount:Double?
    public var skipPolicy:String
    public var seasonStartMonth:Int?
    public var seasonStartDay:Int?
    public var seasonEndMonth:Int?
    public var seasonEndDay:Int?
    public var recurrenceFrequency:String
    public var recurrenceBy:String
    public var recurrenceByValue:String
    public var effectiveStartDate:Date?
    public var endDate:Date?
    public var preferredCrewID:Int?
    public var preferredCrewName:String
    public var externalRef:String
    public var createdBy:String
    public var createdAt:Date?
    public var updatedBy:String
    public var updatedAt:Date?
    public var nextVisitDate:Date?
    public var visitsThisPeriod:Int

    required public init(){}
}

public class ServiceAgreementResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var serviceAgreement:[ServiceAgreement] = []

    required public init(){}
}


Swift ServiceAgreementRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","PreferredCrewID":0,"PreferredCrewName":"String","ExternalRef":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedBy":"String","UpdatedAt":"0001-01-01T00:00:00.0000000","NextVisitDate":"0001-01-01T00:00:00.0000000","VisitsThisPeriod":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","PreferredCrewID":0,"PreferredCrewName":"String","ExternalRef":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedBy":"String","UpdatedAt":"0001-01-01T00:00:00.0000000","NextVisitDate":"0001-01-01T00:00:00.0000000","VisitsThisPeriod":0}]}