Trendsic Platform Service

<back to all web services

VisitWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/week
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CrewWeekCell() = 
        member val Date:String = null with get,set
        member val VisitCount:Int32 = new Int32() with get,set
        member val LoadPct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CrewWeekRow() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val CrewColor:String = null with get,set
        member val Cells:ResizeArray<CrewWeekCell> = new ResizeArray<CrewWeekCell>() with get,set

    [<AllowNullLiteral>]
    type VisitWeekResponse() = 
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val Days:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Rows:ResizeArray<CrewWeekRow> = new ResizeArray<CrewWeekRow>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type VisitWeekRequest() = 
        member val From:String = null with get,set
        member val Days:Int32 = new Int32() with get,set

F# 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
		}
	}
}