Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class AgreementPlannerCrew
            Public Overridable Property CrewID As Integer
            Public Overridable Property CrewName As String
            Public Overridable Property CrewColor As String
        End Class

        Public Partial Class AgreementPlannerRequest
            Public Overridable Property From As String
            Public Overridable Property Scope As String
        End Class

        Public Partial Class AgreementPlannerResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property FromIso As String
            Public Overridable Property ToIso As String
            Public Overridable Property WeekdayCapacity As Integer
            Public Overridable Property Rows As List(Of AgreementPlannerRow) = New List(Of AgreementPlannerRow)
            Public Overridable Property Crews As List(Of AgreementPlannerCrew) = New List(Of AgreementPlannerCrew)
        End Class

        Public Partial Class AgreementPlannerRow
            Public Overridable Property AgreementID As Integer
            Public Overridable Property Name As String
            Public Overridable Property ProjectName As String
            Public Overridable Property ServiceType As String
            Public Overridable Property Area As String
            Public Overridable Property Zip As String
            Public Overridable Property Frequency As String
            Public Overridable Property NextDueIso As String
            Public Overridable Property NextDueLabel As String
            Public Overridable Property Overdue As Boolean
            Public Overridable Property DurationMin As Integer
            Public Overridable Property EligibleDow As List(Of Integer) = New List(Of Integer)
            Public Overridable Property ScheduledDow As Integer
            Public Overridable Property WeeklyAll As Boolean
            Public Overridable Property DueThisWeek As Boolean
            Public Overridable Property AssignedCrewID As Integer?
            Public Overridable Property AssignedCrewName As String
            Public Overridable Property ThisWeekJobID As Integer?
            Public Overridable Property ThisWeekBackingJobID As Integer?
            Public Overridable Property ThisWeekOccIso As String
            Public Overridable Property ThisWeekStandingIso As String
            Public Overridable Property StandingDow As Integer?
            Public Overridable Property Moved As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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>