Trendsic Platform Service

<back to all web services

VisitWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/week
VisitWeekRequest Parameters:
NameParameterData TypeRequiredDescription
FromquerystringNo
DaysqueryintNo
VisitWeekResponse Parameters:
NameParameterData TypeRequiredDescription
FromformstringNo
ToformstringNo
DaysformList<string>No
RowsformList<CrewWeekRow>No
ResponseStatusformResponseStatusNo
CrewWeekRow Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
CrewNameformstringNo
CrewColorformstringNo
CellsformList<CrewWeekCell>No
CrewWeekCell Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
VisitCountformintNo
LoadPctformintNo

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/visits/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	From: String,
	To: String,
	Days: 
	[
		String
	],
	Rows: 
	[
		{
			CrewID: 0,
			CrewName: String,
			CrewColor: String,
			Cells: 
			[
				{
					Date: String,
					VisitCount: 0,
					LoadPct: 0
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}