Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
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 AgreementPlannerRow() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val ProjectName:String = null with get,set
        member val ServiceType:String = null with get,set
        member val Area:String = null with get,set
        member val Zip:String = null with get,set
        member val Frequency:String = null with get,set
        member val NextDueIso:String = null with get,set
        member val NextDueLabel:String = null with get,set
        member val Overdue:Boolean = new Boolean() with get,set
        member val DurationMin:Int32 = new Int32() with get,set
        member val EligibleDow:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val ScheduledDow:Int32 = new Int32() with get,set
        member val WeeklyAll:Boolean = new Boolean() with get,set
        member val DueThisWeek:Boolean = new Boolean() with get,set
        member val AssignedCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssignedCrewName:String = null with get,set
        member val ThisWeekJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ThisWeekBackingJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ThisWeekOccIso:String = null with get,set
        member val ThisWeekStandingIso:String = null with get,set
        member val StandingDow:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Moved:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type AgreementPlannerCrew() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val CrewColor:String = null with get,set

    [<AllowNullLiteral>]
    type AgreementPlannerResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val FromIso:String = null with get,set
        member val ToIso:String = null with get,set
        member val WeekdayCapacity:Int32 = new Int32() with get,set
        member val Rows:ResizeArray<AgreementPlannerRow> = new ResizeArray<AgreementPlannerRow>() with get,set
        member val Crews:ResizeArray<AgreementPlannerCrew> = new ResizeArray<AgreementPlannerCrew>() with get,set

    [<AllowNullLiteral>]
    type AgreementPlannerRequest() = 
        member val From:String = null with get,set
        member val Scope:String = null with get,set

F# AgreementPlannerRequest 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.

GET /v1/serviceagreement/planner HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
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"}},"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"}]}