Trendsic Platform Service

AgreementPlannerRequest

The following routes are available for this service:
GET,OPTIONS	/v1/serviceagreement/planner

**AgreementPlannerRequest** Parameters:
Name	Parameter	Data Type	Required	Description
From	query	string	No
Scope	query	string	No

**AgreementPlannerResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
FromIso	form	string	No
ToIso	form	string	No
WeekdayCapacity	form	int	No
Rows	form	List<AgreementPlannerRow>	No
Crews	form	List<AgreementPlannerCrew>	No

**AgreementPlannerRow** Parameters:
Name	Parameter	Data Type	Required
AgreementID	form	int	No
Name	form	string	No
ProjectName	form	string	No
ServiceType	form	string	No
Area	form	string	No
Zip	form	string	No
Frequency	form	string	No
NextDueIso	form	string	No
NextDueLabel	form	string	No
Overdue	form	bool	No
DurationMin	form	int	No
EligibleDow	form	List<int>	No
ScheduledDow	form	int	No
WeeklyAll	form	bool	No
DueThisWeek	form	bool	No
AssignedCrewID	form	int?	No
AssignedCrewName	form	string	No
ThisWeekJobID	form	int?	No
ThisWeekBackingJobID	form	int?	No
ThisWeekOccIso	form	string	No
ThisWeekStandingIso	form	string	No
StandingDow	form	int?	No
Moved	form	bool	No

**AgreementPlannerCrew** Parameters:
Name	Parameter	Data Type	Required
CrewID	form	int	No
CrewName	form	string	No
CrewColor	form	string	No

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>