Trendsic Platform Service

<back to all web services

MarkupRaiseRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class MarkupRaiseRequest
{
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var ShapeId:String? = null
    open var Raise:String? = null
    open var ProjectID:Int? = null
    open var Title:String? = null
    open var Description:String? = null
    open var Area:String? = null
    open var Trade:String? = null
    open var AssignedSub:String? = null
    open var Priority:String? = null
    open var AskedOf:String? = null
    open var Discipline:String? = null
    open var DueDate:Date? = null
}

open class MarkupRaiseResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Link:DocumentMarkupLink? = null
    open var Links:ArrayList<DocumentMarkupLink> = ArrayList<DocumentMarkupLink>()
}

open class DocumentMarkupLink
{
    open var DocumentMarkupLinkID:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var PageIndex:Int? = null
    open var ShapeId:String? = null
    open var EntityType:String? = null
    open var EntityID:Int? = null
    open var EntityNo:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
}

Kotlin MarkupRaiseRequest 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/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0,
	PageIndex: 0,
	ShapeId: String,
	Raise: String,
	ProjectID: 0,
	Title: String,
	Description: String,
	Area: String,
	Trade: String,
	AssignedSub: String,
	Priority: String,
	AskedOf: String,
	Discipline: String,
	DueDate: 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
		}
	},
	Link: 
	{
		DocumentMarkupLinkID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		PageIndex: 0,
		ShapeId: String,
		EntityType: String,
		EntityID: 0,
		EntityNo: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01
	},
	Links: 
	[
		{
			DocumentMarkupLinkID: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			PageIndex: 0,
			ShapeId: String,
			EntityType: String,
			EntityID: 0,
			EntityNo: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01
		}
	]
}