Trendsic Platform Service

<back to all web services

VisitWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/week
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 CrewWeekCell:
    date: Optional[str] = None
    visit_count: int = 0
    load_pct: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CrewWeekRow:
    crew_i_d: int = 0
    crew_name: Optional[str] = None
    crew_color: Optional[str] = None
    cells: List[CrewWeekCell] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VisitWeekResponse:
    from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
    to: Optional[str] = None
    days: List[str] = field(default_factory=list)
    rows: List[CrewWeekRow] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VisitWeekRequest:
    from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
    days: int = 0

Python VisitWeekRequest 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/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
		}
	}
}