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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementPlannerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <AgreementPlannerCrew>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
    </AgreementPlannerCrew>
  </Crews>
  <FromIso>String</FromIso>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Rows>
    <AgreementPlannerRow>
      <AgreementID>0</AgreementID>
      <Area>String</Area>
      <AssignedCrewID>0</AssignedCrewID>
      <AssignedCrewName>String</AssignedCrewName>
      <DueThisWeek>false</DueThisWeek>
      <DurationMin>0</DurationMin>
      <EligibleDow xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </EligibleDow>
      <Frequency>String</Frequency>
      <Moved>false</Moved>
      <Name>String</Name>
      <NextDueIso>String</NextDueIso>
      <NextDueLabel>String</NextDueLabel>
      <Overdue>false</Overdue>
      <ProjectName>String</ProjectName>
      <ScheduledDow>0</ScheduledDow>
      <ServiceType>String</ServiceType>
      <StandingDow>0</StandingDow>
      <ThisWeekBackingJobID>0</ThisWeekBackingJobID>
      <ThisWeekJobID>0</ThisWeekJobID>
      <ThisWeekOccIso>String</ThisWeekOccIso>
      <ThisWeekStandingIso>String</ThisWeekStandingIso>
      <WeeklyAll>false</WeeklyAll>
      <Zip>String</Zip>
    </AgreementPlannerRow>
  </Rows>
  <ToIso>String</ToIso>
  <WeekdayCapacity>0</WeekdayCapacity>
</AgreementPlannerResponse>