Trendsic Platform Service

<back to all web services

VisitChecklistAddRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visit/{AgreementJobID}/checklist/add
import Foundation
import ServiceStack

public class VisitChecklistAddRequest : Codable
{
    public var agreementJobID:Int
    public var serviceTaskID:Int?
    public var name:String

    required public init(){}
}

public class VisitChecklistResponse : Codable
{
    public var items:[VisitChecklistItem] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class VisitChecklistItem : Codable
{
    public var visitChecklistItemID:Int
    public var agreementJobID:Int
    public var serviceTaskID:Int?
    public var name:String
    public var status:Int
    public var note:String
    public var qaResult:String
    public var attachmentId:Int?
    public var completedBy:String
    public var completedAt:Date?
    public var sortOrder:Int

    required public init(){}
}


Swift VisitChecklistAddRequest 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/visit/{AgreementJobID}/checklist/add HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementJobID: 0,
	ServiceTaskID: 0,
	Name: 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
		}
	}
}