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
import Foundation
import ServiceStack

public class LinesRequest : Codable
{
    public var id:String
    public var locationId:String
    public var lines:[Line] = []

    required public init(){}
}

public class Line : Codable
{
    public var id:String
    public var locationId:String
    public var locationName:String
    public var name:String
    public var Description:String
    public var serviceDurationMinutes:Int
    public var waitTime:Int
    public var cost:Double
    public var upperThreshold:Int?
    public var lowerThreshold:Int?
    public var active:Bool
    public var entDate:Date?
    public var modDate:Date?
    public var sendQuestionnaire:Bool
    public var requireUpload:Bool
    public var uploadMessage:String
    public var lineImages:[LineImage] = []

    required public init(){}
}

public class LineImage : Codable
{
    public var imageId:String?
    public var fileName:String
    public var imageTitle:String
    public var uploadDate:Date

    required public init(){}
}

public class LinesResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var lines:[Line] = []

    required public init(){}
}


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