Trendsic Platform Service

<back to all web services

PortalVisitsRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/visits
PortalVisitsRequest Parameters:
NameParameterData TypeRequiredDescription
TokenpathstringNo
PortalVisitsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
VisitsformList<CustomerVisit>No
PhotosformList<CustomerVisitPhoto>No
CustomerVisit Parameters:
NameParameterData TypeRequiredDescription
AgreementJobIDformintNo
VisitDateformDateTime?No
CompletedAtformDateTime?No
ServiceNameformstringNo
CrewNotesformstringNo
CustomerVisitPhoto Parameters:
NameParameterData TypeRequiredDescription
ProjectLocationAttachmentIDformintNo
AgreementJobIDformint?No
DocTitleformstringNo
MimeTypeformstringNo
UploadDateformDateTime?No

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
		}
	]
}