Trendsic Platform Service

<back to all web services

JobEquipmentRequest

The following routes are available for this service:
PUT,OPTIONS/v1/Job/equipment

export class CalendarEvent
{
    public CalendarEventId: number;
    public CalendarId: string;
    public EventStart: string;
    public EventEnd: string;
    public Location: string;
    public Summary: string;
    public Description: string;
    public EventTypeId: number;
    public Recurrence: boolean;
    public RecurrenceFrequency: string;
    public RecurrenceBy: string;
    public RecurrenceByValue: string;
    public RecurrenceUntil: string;
    public CreatedBy: string;
    public CreatedByName: string;
    public DateCreated: string;
    public ModifiedBy: string;
    public DateModified: string;
    public Deleted: boolean;
    public TimeZone: string;
    public Offset: number;
    public TextReminderSentDate: string;
    public Confirmed: boolean;
    public ConfirmationTextId: string;
    public FirstTextReminderId: string;
    public SecondTextReminderId: string;
    public LocationUID?: string;
    public AgentReminderSentDate: string;
    public ContactId: number;
    public IsPrivate: boolean;
    public ProjectID: number;
    public JobID: number;
    public ProjectStartDate: string;
    public ProjectEndDate: string;
    public MaxCrewEndDate: string;
    public MaxEquipmentEndDate: string;
    public CheckInId: string;
    public AllDay: boolean;
    public JobName: string;
    public JobStatusName: string;
    public JobStatusId: number;
    public ProjectName: string;
    public ResourceId: number;
    public ResourceName: string;
    public Original_EventStart: string;
    public Original_Recurrence: boolean;
    public Original_RecurrenceFrequency: string;
    public Original_RecurrenceBy: string;
    public Original_RecurrenceByValue: string;
    public Original_RecurrenceUntil: string;
    public Checksum: string;

    public constructor(init?: Partial<CalendarEvent>) { (Object as any).assign(this, init); }
}

export class Location
{
    public Id: string;
    public ClientId: string;
    public Name: string;
    public Address1: string;
    public Address2: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Phone: string;
    public Fax: string;
    public URL: string;
    public Email: string;
    public TimeZone: string;
    public Active: boolean;
    public EntDate: string;
    public ModDate: string;
    public LocationImage: string;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class Job
{
    public JobID: number;
    public JobName: string;
    public Description: string;
    public JobTypeID: number;
    public ExpectedStartDate: string;
    public ActualStartDate: string;
    public ExpectedCompletionDate: string;
    public ActualEndDate: string;
    public Active: boolean;
    public CreatedByUID: string;
    public ProjectID: number;
    public StatusId: number;
    public AdvancedScheduling: boolean;
    public ShowTimes: boolean;
    public Schedule: CalendarEvent[] = [];
    public HasScheduledWorkers: boolean;
    public HasScheduledPlaceholders: boolean;
    public ClientApprovalStatus: string;
    public InternalCost: number;
    public CostToClient: number;
    public Location: Location;
    public ProjectLocationID?: number;
    public ProjectLocationAreaID?: number;
    public ProjectLocationName: string;
    public ProjectLocationAddress1: string;
    public ProjectLocationAddress2: string;
    public ProjectLocationCity: string;
    public ProjectLocationState: string;
    public ProjectLocationZip: string;
    public ProjectLocationAreaName: string;

    public constructor(init?: Partial<Job>) { (Object as any).assign(this, init); }
}

export class JobResponse
{
    public ResponseStatus: ResponseStatus;
    public Job: Job[] = [];
    public RequiresConfirm: boolean;

    public constructor(init?: Partial<JobResponse>) { (Object as any).assign(this, init); }
}

export class JobEquipmentRequest
{
    public ProjectID: number;
    public JobID: number;
    public EquipmentID: number;
    public AddRemove: number;
    public BookedFrom: string;
    public BookedTo: string;

    public constructor(init?: Partial<JobEquipmentRequest>) { (Object as any).assign(this, init); }
}

TypeScript JobEquipmentRequest 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.

PUT /v1/Job/equipment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JobEquipmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AddRemove>0</AddRemove>
  <BookedFrom>String</BookedFrom>
  <BookedTo>String</BookedTo>
  <EquipmentID>0</EquipmentID>
  <JobID>0</JobID>
  <ProjectID>0</ProjectID>
</JobEquipmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Job>
    <Job>
      <Active>false</Active>
      <ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
      <ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
      <AdvancedScheduling>false</AdvancedScheduling>
      <ClientApprovalStatus>String</ClientApprovalStatus>
      <CostToClient>0</CostToClient>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <Description>String</Description>
      <ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
      <ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
      <HasScheduledPlaceholders>false</HasScheduledPlaceholders>
      <HasScheduledWorkers>false</HasScheduledWorkers>
      <InternalCost>0</InternalCost>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <JobTypeID>0</JobTypeID>
      <Location>
        <Active>false</Active>
        <Address1>String</Address1>
        <Address2>String</Address2>
        <City>String</City>
        <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
        <Email>String</Email>
        <EntDate>0001-01-01T00:00:00</EntDate>
        <Fax>String</Fax>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <LocationImage>String</LocationImage>
        <ModDate>0001-01-01T00:00:00</ModDate>
        <Name>String</Name>
        <Phone>String</Phone>
        <State>String</State>
        <TimeZone>String</TimeZone>
        <URL>String</URL>
        <Zip>String</Zip>
      </Location>
      <ProjectID>0</ProjectID>
      <ProjectLocationAddress1>String</ProjectLocationAddress1>
      <ProjectLocationAddress2>String</ProjectLocationAddress2>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationAreaName>String</ProjectLocationAreaName>
      <ProjectLocationCity>String</ProjectLocationCity>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationName>String</ProjectLocationName>
      <ProjectLocationState>String</ProjectLocationState>
      <ProjectLocationZip>String</ProjectLocationZip>
      <Schedule>
        <CalendarEvent>
          <AgentReminderSentDate>0001-01-01T00:00:00</AgentReminderSentDate>
          <AllDay>false</AllDay>
          <CalendarEventId>0</CalendarEventId>
          <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
          <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
          <Checksum>String</Checksum>
          <ConfirmationTextId>String</ConfirmationTextId>
          <Confirmed>false</Confirmed>
          <ContactId>0</ContactId>
          <CreatedBy>String</CreatedBy>
          <CreatedByName>String</CreatedByName>
          <DateCreated>0001-01-01T00:00:00</DateCreated>
          <DateModified>0001-01-01T00:00:00</DateModified>
          <Deleted>false</Deleted>
          <Description>String</Description>
          <EventEnd>0001-01-01T00:00:00</EventEnd>
          <EventStart>0001-01-01T00:00:00</EventStart>
          <EventTypeId>0</EventTypeId>
          <FirstTextReminderId>String</FirstTextReminderId>
          <IsPrivate>false</IsPrivate>
          <JobID>0</JobID>
          <JobName>String</JobName>
          <JobStatusId>0</JobStatusId>
          <JobStatusName>String</JobStatusName>
          <Location>String</Location>
          <LocationUID>00000000-0000-0000-0000-000000000000</LocationUID>
          <MaxCrewEndDate>0001-01-01T00:00:00</MaxCrewEndDate>
          <MaxEquipmentEndDate>0001-01-01T00:00:00</MaxEquipmentEndDate>
          <ModifiedBy>String</ModifiedBy>
          <Offset>0</Offset>
          <Original_EventStart>0001-01-01T00:00:00</Original_EventStart>
          <Original_Recurrence>false</Original_Recurrence>
          <Original_RecurrenceBy>String</Original_RecurrenceBy>
          <Original_RecurrenceByValue>String</Original_RecurrenceByValue>
          <Original_RecurrenceFrequency>String</Original_RecurrenceFrequency>
          <Original_RecurrenceUntil>0001-01-01T00:00:00</Original_RecurrenceUntil>
          <ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
          <ProjectID>0</ProjectID>
          <ProjectName>String</ProjectName>
          <ProjectStartDate>0001-01-01T00:00:00</ProjectStartDate>
          <Recurrence>false</Recurrence>
          <RecurrenceBy>String</RecurrenceBy>
          <RecurrenceByValue>String</RecurrenceByValue>
          <RecurrenceFrequency>String</RecurrenceFrequency>
          <RecurrenceUntil>0001-01-01T00:00:00</RecurrenceUntil>
          <ResourceId>0</ResourceId>
          <ResourceName>String</ResourceName>
          <SecondTextReminderId>String</SecondTextReminderId>
          <Summary>String</Summary>
          <TextReminderSentDate>0001-01-01T00:00:00</TextReminderSentDate>
          <TimeZone>String</TimeZone>
        </CalendarEvent>
      </Schedule>
      <ShowTimes>false</ShowTimes>
      <StatusId>0</StatusId>
    </Job>
  </Job>
  <RequiresConfirm>false</RequiresConfirm>
  <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>
</JobResponse>