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

public class dtos
{

    public static class AgreementPlannerRequest
    {
        public String From = null;
        public String Scope = null;
        
        public String getFrom() { return From; }
        public AgreementPlannerRequest setFrom(String value) { this.From = value; return this; }
        public String getScope() { return Scope; }
        public AgreementPlannerRequest setScope(String value) { this.Scope = value; return this; }
    }

    public static class AgreementPlannerResponse
    {
        public ResponseStatus ResponseStatus = null;
        public String FromIso = null;
        public String ToIso = null;
        public Integer WeekdayCapacity = null;
        public ArrayList<AgreementPlannerRow> Rows = new ArrayList<AgreementPlannerRow>();
        public ArrayList<AgreementPlannerCrew> Crews = new ArrayList<AgreementPlannerCrew>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AgreementPlannerResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public String getFromIso() { return FromIso; }
        public AgreementPlannerResponse setFromIso(String value) { this.FromIso = value; return this; }
        public String getToIso() { return ToIso; }
        public AgreementPlannerResponse setToIso(String value) { this.ToIso = value; return this; }
        public Integer getWeekdayCapacity() { return WeekdayCapacity; }
        public AgreementPlannerResponse setWeekdayCapacity(Integer value) { this.WeekdayCapacity = value; return this; }
        public ArrayList<AgreementPlannerRow> getRows() { return Rows; }
        public AgreementPlannerResponse setRows(ArrayList<AgreementPlannerRow> value) { this.Rows = value; return this; }
        public ArrayList<AgreementPlannerCrew> getCrews() { return Crews; }
        public AgreementPlannerResponse setCrews(ArrayList<AgreementPlannerCrew> value) { this.Crews = value; return this; }
    }

    public static class AgreementPlannerRow
    {
        public Integer AgreementID = null;
        public String Name = null;
        public String ProjectName = null;
        public String ServiceType = null;
        public String Area = null;
        public String Zip = null;
        public String Frequency = null;
        public String NextDueIso = null;
        public String NextDueLabel = null;
        public Boolean Overdue = null;
        public Integer DurationMin = null;
        public ArrayList<Integer> EligibleDow = new ArrayList<Integer>();
        public Integer ScheduledDow = null;
        public Boolean WeeklyAll = null;
        public Boolean DueThisWeek = null;
        public Integer AssignedCrewID = null;
        public String AssignedCrewName = null;
        public Integer ThisWeekJobID = null;
        public Integer ThisWeekBackingJobID = null;
        public String ThisWeekOccIso = null;
        public String ThisWeekStandingIso = null;
        public Integer StandingDow = null;
        public Boolean Moved = null;
        
        public Integer getAgreementID() { return AgreementID; }
        public AgreementPlannerRow setAgreementID(Integer value) { this.AgreementID = value; return this; }
        public String getName() { return Name; }
        public AgreementPlannerRow setName(String value) { this.Name = value; return this; }
        public String getProjectName() { return ProjectName; }
        public AgreementPlannerRow setProjectName(String value) { this.ProjectName = value; return this; }
        public String getServiceType() { return ServiceType; }
        public AgreementPlannerRow setServiceType(String value) { this.ServiceType = value; return this; }
        public String getArea() { return Area; }
        public AgreementPlannerRow setArea(String value) { this.Area = value; return this; }
        public String getZip() { return Zip; }
        public AgreementPlannerRow setZip(String value) { this.Zip = value; return this; }
        public String getFrequency() { return Frequency; }
        public AgreementPlannerRow setFrequency(String value) { this.Frequency = value; return this; }
        public String getNextDueIso() { return NextDueIso; }
        public AgreementPlannerRow setNextDueIso(String value) { this.NextDueIso = value; return this; }
        public String getNextDueLabel() { return NextDueLabel; }
        public AgreementPlannerRow setNextDueLabel(String value) { this.NextDueLabel = value; return this; }
        public Boolean isOverdue() { return Overdue; }
        public AgreementPlannerRow setOverdue(Boolean value) { this.Overdue = value; return this; }
        public Integer getDurationMin() { return DurationMin; }
        public AgreementPlannerRow setDurationMin(Integer value) { this.DurationMin = value; return this; }
        public ArrayList<Integer> getEligibleDow() { return EligibleDow; }
        public AgreementPlannerRow setEligibleDow(ArrayList<Integer> value) { this.EligibleDow = value; return this; }
        public Integer getScheduledDow() { return ScheduledDow; }
        public AgreementPlannerRow setScheduledDow(Integer value) { this.ScheduledDow = value; return this; }
        public Boolean isWeeklyAll() { return WeeklyAll; }
        public AgreementPlannerRow setWeeklyAll(Boolean value) { this.WeeklyAll = value; return this; }
        public Boolean isDueThisWeek() { return DueThisWeek; }
        public AgreementPlannerRow setDueThisWeek(Boolean value) { this.DueThisWeek = value; return this; }
        public Integer getAssignedCrewID() { return AssignedCrewID; }
        public AgreementPlannerRow setAssignedCrewID(Integer value) { this.AssignedCrewID = value; return this; }
        public String getAssignedCrewName() { return AssignedCrewName; }
        public AgreementPlannerRow setAssignedCrewName(String value) { this.AssignedCrewName = value; return this; }
        public Integer getThisWeekJobID() { return ThisWeekJobID; }
        public AgreementPlannerRow setThisWeekJobID(Integer value) { this.ThisWeekJobID = value; return this; }
        public Integer getThisWeekBackingJobID() { return ThisWeekBackingJobID; }
        public AgreementPlannerRow setThisWeekBackingJobID(Integer value) { this.ThisWeekBackingJobID = value; return this; }
        public String getThisWeekOccIso() { return ThisWeekOccIso; }
        public AgreementPlannerRow setThisWeekOccIso(String value) { this.ThisWeekOccIso = value; return this; }
        public String getThisWeekStandingIso() { return ThisWeekStandingIso; }
        public AgreementPlannerRow setThisWeekStandingIso(String value) { this.ThisWeekStandingIso = value; return this; }
        public Integer getStandingDow() { return StandingDow; }
        public AgreementPlannerRow setStandingDow(Integer value) { this.StandingDow = value; return this; }
        public Boolean isMoved() { return Moved; }
        public AgreementPlannerRow setMoved(Boolean value) { this.Moved = value; return this; }
    }

    public static class AgreementPlannerCrew
    {
        public Integer CrewID = null;
        public String CrewName = null;
        public String CrewColor = null;
        
        public Integer getCrewID() { return CrewID; }
        public AgreementPlannerCrew setCrewID(Integer value) { this.CrewID = value; return this; }
        public String getCrewName() { return CrewName; }
        public AgreementPlannerCrew setCrewName(String value) { this.CrewName = value; return this; }
        public String getCrewColor() { return CrewColor; }
        public AgreementPlannerCrew setCrewColor(String value) { this.CrewColor = value; return this; }
    }

}

Java 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>