Trendsic Platform Service

<back to all web services

PortalVisitsRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/visits
import Foundation
import ServiceStack

public class PortalVisitsRequest : Codable
{
    public var token:String

    required public init(){}
}

public class PortalVisitsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var visits:[CustomerVisit] = []
    public var photos:[CustomerVisitPhoto] = []

    required public init(){}
}

public class CustomerVisit : Codable
{
    public var agreementJobID:Int
    public var visitDate:Date?
    public var completedAt:Date?
    public var serviceName:String
    public var crewNotes:String

    required public init(){}
}

public class CustomerVisitPhoto : Codable
{
    public var projectLocationAttachmentID:Int
    public var agreementJobID:Int?
    public var docTitle:String
    public var mimeType:String
    public var uploadDate:Date?

    required public init(){}
}


Swift PortalVisitsRequest 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 /portal/{Token}/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,
			VisitDate: 0001-01-01,
			CompletedAt: 0001-01-01,
			ServiceName: String,
			CrewNotes: String
		}
	],
	Photos: 
	[
		{
			ProjectLocationAttachmentID: 0,
			AgreementJobID: 0,
			DocTitle: String,
			MimeType: String,
			UploadDate: 0001-01-01
		}
	]
}