Trendsic Platform Service

<back to all web services

LinesRequest

Requires Authentication
Required roles:Administrator, Administrator, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Lines/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/LinesByLocationId/{LocationId}
GET,POST,PUT,DELETE,OPTIONS/v1/Lines

export class LineImage
{
    public ImageId?: string;
    public FileName: string;
    public ImageTitle: string;
    public UploadDate: string;

    public constructor(init?: Partial<LineImage>) { (Object as any).assign(this, init); }
}

export class Line
{
    public Id: string;
    public LocationId: string;
    public LocationName: string;
    public Name: string;
    public Description: string;
    public ServiceDurationMinutes: number;
    public WaitTime: number;
    public Cost: number;
    public UpperThreshold?: number;
    public LowerThreshold?: number;
    public Active: boolean;
    public EntDate?: string;
    public ModDate?: string;
    public SendQuestionnaire: boolean;
    public RequireUpload: boolean;
    public UploadMessage: string;
    public LineImages: LineImage[] = [];

    public constructor(init?: Partial<Line>) { (Object as any).assign(this, init); }
}

export class LinesResponse
{
    public ResponseStatus: ResponseStatus;
    public Lines: Line[] = [];

    public constructor(init?: Partial<LinesResponse>) { (Object as any).assign(this, init); }
}

export class LinesRequest
{
    public Id: string;
    public LocationId: string;
    public Lines: Line[] = [];

    public constructor(init?: Partial<LinesRequest>) { (Object as any).assign(this, init); }
}

TypeScript LinesRequest 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.

POST /v1/Lines/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 00000000000000000000000000000000,
	LocationId: 00000000000000000000000000000000,
	Lines: 
	[
		{
			Id: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			LocationName: String,
			Name: String,
			Description: String,
			ServiceDurationMinutes: 0,
			WaitTime: 0,
			Cost: 0,
			UpperThreshold: 0,
			LowerThreshold: 0,
			Active: False,
			EntDate: 0001-01-01,
			ModDate: 0001-01-01,
			SendQuestionnaire: False,
			RequireUpload: False,
			UploadMessage: String,
			LineImages: 
			[
				{
					ImageId: 00000000000000000000000000000000,
					FileName: String,
					ImageTitle: String,
					UploadDate: 0001-01-01
				}
			]
		}
	]
}
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
		}
	},
	Lines: 
	[
		{
			Id: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			LocationName: String,
			Name: String,
			Description: String,
			ServiceDurationMinutes: 0,
			WaitTime: 0,
			Cost: 0,
			UpperThreshold: 0,
			LowerThreshold: 0,
			Active: False,
			EntDate: 0001-01-01,
			ModDate: 0001-01-01,
			SendQuestionnaire: False,
			RequireUpload: False,
			UploadMessage: String,
			LineImages: 
			[
				{
					ImageId: 00000000000000000000000000000000,
					FileName: String,
					ImageTitle: String,
					UploadDate: 0001-01-01
				}
			]
		}
	]
}