Trendsic Platform Service

<back to all web services

WorkerVisitChecklistItemRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/worker/visit/{WorkerScheduleItemID}/checklist/item
"use strict";
export class VisitChecklistItem {
    /** @param {{VisitChecklistItemID?:number,AgreementJobID?:number,ServiceTaskID?:number,Name?:string,Status?:number,Note?:string,QaResult?:string,AttachmentId?:number,CompletedBy?:string,CompletedAt?:string,SortOrder?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VisitChecklistItemID;
    /** @type {number} */
    AgreementJobID;
    /** @type {?number} */
    ServiceTaskID;
    /** @type {string} */
    Name;
    /** @type {number} */
    Status;
    /** @type {string} */
    Note;
    /** @type {string} */
    QaResult;
    /** @type {?number} */
    AttachmentId;
    /** @type {string} */
    CompletedBy;
    /** @type {?string} */
    CompletedAt;
    /** @type {number} */
    SortOrder;
}
export class VisitChecklistResponse {
    /** @param {{Items?:VisitChecklistItem[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VisitChecklistItem[]} */
    Items = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class WorkerVisitChecklistItemRequest {
    /** @param {{WorkerScheduleItemID?:number,VisitChecklistItemID?:number,Status?:number,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkerScheduleItemID;
    /** @type {number} */
    VisitChecklistItemID;
    /** @type {number} */
    Status;
    /** @type {string} */
    Note;
}

JavaScript WorkerVisitChecklistItemRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/worker/visit/{WorkerScheduleItemID}/checklist/item HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkerScheduleItemID: 0,
	VisitChecklistItemID: 0,
	Status: 0,
	Note: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			VisitChecklistItemID: 0,
			AgreementJobID: 0,
			ServiceTaskID: 0,
			Name: String,
			Status: 0,
			Note: String,
			QaResult: String,
			AttachmentId: 0,
			CompletedBy: String,
			CompletedAt: 0001-01-01,
			SortOrder: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}