Trendsic Platform Service

<back to all web services

AgreementVisitCompleteRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/serviceagreement/visit/{AgreementJobID}/complete
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 AgreementVisit:
    agreement_job_i_d: int = 0
    agreement_i_d: int = 0
    job_i_d: int = 0
    occurrence_date: Optional[datetime.datetime] = None
    status: Optional[str] = None
    completed_at: Optional[datetime.datetime] = None
    cancelled_at: Optional[datetime.datetime] = None
    cancel_reason: Optional[str] = None
    shifted_to_date: Optional[datetime.datetime] = None
    actual_duration_minutes: Optional[int] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgreementVisitCompleteRequest:
    agreement_job_i_d: int = 0

Python AgreementVisitCompleteRequest 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/serviceagreement/visit/{AgreementJobID}/complete HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementJobID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Visits: 
	[
		{
			AgreementJobID: 0,
			AgreementID: 0,
			JobID: 0,
			OccurrenceDate: 0001-01-01,
			Status: String,
			CompletedAt: 0001-01-01,
			CancelledAt: 0001-01-01,
			CancelReason: String,
			ShiftedToDate: 0001-01-01,
			ActualDurationMinutes: 0
		}
	]
}