| PUT,OPTIONS | /v1/Job/material |
|---|
"use strict";
export class CalendarEvent {
/** @param {{CalendarEventId?:number,CalendarId?:string,EventStart?:string,EventEnd?:string,Location?:string,Summary?:string,Description?:string,EventTypeId?:number,Recurrence?:boolean,RecurrenceFrequency?:string,RecurrenceBy?:string,RecurrenceByValue?:string,RecurrenceUntil?:string,CreatedBy?:string,CreatedByName?:string,DateCreated?:string,ModifiedBy?:string,DateModified?:string,Deleted?:boolean,TimeZone?:string,Offset?:number,TextReminderSentDate?:string,Confirmed?:boolean,ConfirmationTextId?:string,FirstTextReminderId?:string,SecondTextReminderId?:string,LocationUID?:string,AgentReminderSentDate?:string,ContactId?:number,IsPrivate?:boolean,ProjectID?:number,JobID?:number,ProjectStartDate?:string,ProjectEndDate?:string,MaxCrewEndDate?:string,MaxEquipmentEndDate?:string,CheckInId?:string,AllDay?:boolean,JobName?:string,JobStatusName?:string,JobStatusId?:number,ProjectName?:string,ResourceId?:number,ResourceName?:string,Original_EventStart?:string,Original_Recurrence?:boolean,Original_RecurrenceFrequency?:string,Original_RecurrenceBy?:string,Original_RecurrenceByValue?:string,Original_RecurrenceUntil?:string,Checksum?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CalendarEventId;
/** @type {string} */
CalendarId;
/** @type {string} */
EventStart;
/** @type {string} */
EventEnd;
/** @type {string} */
Location;
/** @type {string} */
Summary;
/** @type {string} */
Description;
/** @type {number} */
EventTypeId;
/** @type {boolean} */
Recurrence;
/** @type {string} */
RecurrenceFrequency;
/** @type {string} */
RecurrenceBy;
/** @type {string} */
RecurrenceByValue;
/** @type {string} */
RecurrenceUntil;
/** @type {string} */
CreatedBy;
/** @type {string} */
CreatedByName;
/** @type {string} */
DateCreated;
/** @type {string} */
ModifiedBy;
/** @type {string} */
DateModified;
/** @type {boolean} */
Deleted;
/** @type {string} */
TimeZone;
/** @type {number} */
Offset;
/** @type {string} */
TextReminderSentDate;
/** @type {boolean} */
Confirmed;
/** @type {string} */
ConfirmationTextId;
/** @type {string} */
FirstTextReminderId;
/** @type {string} */
SecondTextReminderId;
/** @type {?string} */
LocationUID;
/** @type {string} */
AgentReminderSentDate;
/** @type {number} */
ContactId;
/** @type {boolean} */
IsPrivate;
/** @type {number} */
ProjectID;
/** @type {number} */
JobID;
/** @type {string} */
ProjectStartDate;
/** @type {string} */
ProjectEndDate;
/** @type {string} */
MaxCrewEndDate;
/** @type {string} */
MaxEquipmentEndDate;
/** @type {string} */
CheckInId;
/** @type {boolean} */
AllDay;
/** @type {string} */
JobName;
/** @type {string} */
JobStatusName;
/** @type {number} */
JobStatusId;
/** @type {string} */
ProjectName;
/** @type {number} */
ResourceId;
/** @type {string} */
ResourceName;
/** @type {string} */
Original_EventStart;
/** @type {boolean} */
Original_Recurrence;
/** @type {string} */
Original_RecurrenceFrequency;
/** @type {string} */
Original_RecurrenceBy;
/** @type {string} */
Original_RecurrenceByValue;
/** @type {string} */
Original_RecurrenceUntil;
/** @type {string} */
Checksum;
}
export class Job {
/** @param {{JobID?:number,JobName?:string,JobTypeID?:number,ExpectedStartDate?:string,ActualStartDate?:string,ExpectedCompletionDate?:string,ActualEndDate?:string,Active?:boolean,CreatedByUID?:string,ProjectID?:number,StatusId?:number,AdvancedScheduling?:boolean,ShowTimes?:boolean,Schedule?:CalendarEvent[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
JobID;
/** @type {string} */
JobName;
/** @type {number} */
JobTypeID;
/** @type {string} */
ExpectedStartDate;
/** @type {string} */
ActualStartDate;
/** @type {string} */
ExpectedCompletionDate;
/** @type {string} */
ActualEndDate;
/** @type {boolean} */
Active;
/** @type {string} */
CreatedByUID;
/** @type {number} */
ProjectID;
/** @type {number} */
StatusId;
/** @type {boolean} */
AdvancedScheduling;
/** @type {boolean} */
ShowTimes;
/** @type {CalendarEvent[]} */
Schedule = [];
}
export class JobResponse {
/** @param {{ResponseStatus?:ResponseStatus,Job?:Job[],RequiresConfirm?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Job[]} */
Job = [];
/** @type {boolean} */
RequiresConfirm;
}
export class JobMaterialRequest {
/** @param {{ProjectID?:number,JobID?:number,MaterialID?:number,AddRemove?:number,StatusId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ProjectID;
/** @type {number} */
JobID;
/** @type {number} */
MaterialID;
/** @type {number} */
AddRemove;
/** @type {number} */
StatusId;
}
JavaScript JobMaterialRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/Job/material HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<JobMaterialRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AddRemove>0</AddRemove>
<JobID>0</JobID>
<MaterialID>0</MaterialID>
<ProjectID>0</ProjectID>
<StatusId>0</StatusId>
</JobMaterialRequest>
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>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
<ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
<JobID>0</JobID>
<JobName>String</JobName>
<JobTypeID>0</JobTypeID>
<ProjectID>0</ProjectID>
<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>