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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type VisitChecklistItem() = 
        member val VisitChecklistItemID:Int32 = new Int32() with get,set
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val ServiceTaskID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set
        member val Status:Int32 = new Int32() with get,set
        member val Note:String = null with get,set
        member val QaResult:String = null with get,set
        member val AttachmentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CompletedBy:String = null with get,set
        member val CompletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type VisitChecklistResponse() = 
        member val Items:ResizeArray<VisitChecklistItem> = new ResizeArray<VisitChecklistItem>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type VisitChecklistAddRequest() = 
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val ServiceTaskID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set

F# 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
		}
	}
}