Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
import Foundation
import ServiceStack

public class AgreementPlannerRequest : Codable
{
    public var from:String
    public var scope:String

    required public init(){}
}

public class AgreementPlannerResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var fromIso:String
    public var toIso:String
    public var weekdayCapacity:Int
    public var rows:[AgreementPlannerRow] = []
    public var crews:[AgreementPlannerCrew] = []

    required public init(){}
}

public class AgreementPlannerRow : Codable
{
    public var agreementID:Int
    public var name:String
    public var projectName:String
    public var serviceType:String
    public var area:String
    public var zip:String
    public var frequency:String
    public var nextDueIso:String
    public var nextDueLabel:String
    public var overdue:Bool
    public var durationMin:Int
    public var eligibleDow:[Int] = []
    public var scheduledDow:Int
    public var weeklyAll:Bool
    public var dueThisWeek:Bool
    public var assignedCrewID:Int?
    public var assignedCrewName:String
    public var thisWeekJobID:Int?
    public var thisWeekBackingJobID:Int?
    public var thisWeekOccIso:String
    public var thisWeekStandingIso:String
    public var standingDow:Int?
    public var moved:Bool

    required public init(){}
}

public class AgreementPlannerCrew : Codable
{
    public var crewID:Int
    public var crewName:String
    public var crewColor:String

    required public init(){}
}


Swift AgreementPlannerRequest 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.

GET /v1/serviceagreement/planner HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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"}},"FromIso":"String","ToIso":"String","WeekdayCapacity":0,"Rows":[{"AgreementID":0,"Name":"String","ProjectName":"String","ServiceType":"String","Area":"String","Zip":"String","Frequency":"String","NextDueIso":"String","NextDueLabel":"String","Overdue":false,"DurationMin":0,"EligibleDow":[0],"ScheduledDow":0,"WeeklyAll":false,"DueThisWeek":false,"AssignedCrewID":0,"AssignedCrewName":"String","ThisWeekJobID":0,"ThisWeekBackingJobID":0,"ThisWeekOccIso":"String","ThisWeekStandingIso":"String","StandingDow":0,"Moved":false}],"Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String"}]}