Trendsic Platform Service

<back to all web services

AgreementVisitsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/{AgreementID}/visits
import Foundation
import ServiceStack

public class AgreementVisitsRequest : Codable
{
    public var agreementID:Int

    required public init(){}
}

public class AgreementVisitsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var visits:[AgreementVisit] = []

    required public init(){}
}

public class AgreementVisit : Codable
{
    public var agreementJobID:Int
    public var agreementID:Int
    public var jobID:Int
    public var occurrenceDate:Date?
    public var status:String
    public var completedAt:Date?
    public var cancelledAt:Date?
    public var cancelReason:String
    public var shiftedToDate:Date?
    public var actualDurationMinutes:Int?

    required public init(){}
}


Swift AgreementVisitsRequest 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.

GET /v1/serviceagreement/{AgreementID}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	]
}