Trendsic Platform Service

<back to all web services

VisitChecklistItemUpdateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visit/{AgreementJobID}/checklist/item
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VisitChecklistItem:
    visit_checklist_item_i_d: int = 0
    agreement_job_i_d: int = 0
    service_task_i_d: Optional[int] = None
    name: Optional[str] = None
    status: int = 0
    note: Optional[str] = None
    qa_result: Optional[str] = None
    attachment_id: Optional[int] = None
    completed_by: Optional[str] = None
    completed_at: Optional[datetime.datetime] = None
    sort_order: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VisitChecklistResponse:
    items: List[VisitChecklistItem] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VisitChecklistItemUpdateRequest:
    agreement_job_i_d: int = 0
    visit_checklist_item_i_d: int = 0
    status: int = 0
    note: Optional[str] = None
    qa_result: Optional[str] = None

Python VisitChecklistItemUpdateRequest 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/item HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementJobID: 0,
	VisitChecklistItemID: 0,
	Status: 0,
	Note: String,
	QaResult: 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
		}
	}
}