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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ServiceAgreementRequest
{
    open var AgreementID:Int? = null
    open var ProjectID:Int? = null
    open var ServiceAgreement:ArrayList<ServiceAgreement> = ArrayList<ServiceAgreement>()
}

open class ServiceAgreement
{
    open var AgreementID:Int? = null
    open var AgreementUID:UUID? = null
    open var TenantId:UUID? = null
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var ProjectID:Int? = null
    open var ProjectName:String? = null
    open var Name:String? = null
    open var Status:String? = null
    open var PricingShape:String? = null
    open var MonthlyAmount:BigDecimal? = null
    open var PerVisitAmount:BigDecimal? = null
    open var SkipPolicy:String? = null
    open var SeasonStartMonth:Int? = null
    open var SeasonStartDay:Int? = null
    open var SeasonEndMonth:Int? = null
    open var SeasonEndDay:Int? = null
    open var RecurrenceFrequency:String? = null
    open var RecurrenceBy:String? = null
    open var RecurrenceByValue:String? = null
    open var EffectiveStartDate:Date? = null
    open var EndDate:Date? = null
    open var PreferredCrewID:Int? = null
    open var PreferredCrewName:String? = null
    open var ExternalRef:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedBy:String? = null
    open var UpdatedAt:Date? = null
    open var NextVisitDate:Date? = null
    open var VisitsThisPeriod:Int? = null
}

open class ServiceAgreementResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var ServiceAgreement:ArrayList<ServiceAgreement> = ArrayList<ServiceAgreement>()
}

Kotlin ServiceAgreementRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}