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.*;

public class dtos
{

    public static class MarkupRaiseRequest
    {
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public String ShapeId = null;
        public String Raise = null;
        public Integer ProjectID = null;
        public String Title = null;
        public String Description = null;
        public String Area = null;
        public String Trade = null;
        public String AssignedSub = null;
        public String Priority = null;
        public String AskedOf = null;
        public String Discipline = null;
        public Date DueDate = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public MarkupRaiseRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public MarkupRaiseRequest setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public MarkupRaiseRequest setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public String getShapeId() { return ShapeId; }
        public MarkupRaiseRequest setShapeId(String value) { this.ShapeId = value; return this; }
        public String getRaise() { return Raise; }
        public MarkupRaiseRequest setRaise(String value) { this.Raise = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public MarkupRaiseRequest setProjectID(Integer value) { this.ProjectID = value; return this; }
        public String getTitle() { return Title; }
        public MarkupRaiseRequest setTitle(String value) { this.Title = value; return this; }
        public String getDescription() { return Description; }
        public MarkupRaiseRequest setDescription(String value) { this.Description = value; return this; }
        public String getArea() { return Area; }
        public MarkupRaiseRequest setArea(String value) { this.Area = value; return this; }
        public String getTrade() { return Trade; }
        public MarkupRaiseRequest setTrade(String value) { this.Trade = value; return this; }
        public String getAssignedSub() { return AssignedSub; }
        public MarkupRaiseRequest setAssignedSub(String value) { this.AssignedSub = value; return this; }
        public String getPriority() { return Priority; }
        public MarkupRaiseRequest setPriority(String value) { this.Priority = value; return this; }
        public String getAskedOf() { return AskedOf; }
        public MarkupRaiseRequest setAskedOf(String value) { this.AskedOf = value; return this; }
        public String getDiscipline() { return Discipline; }
        public MarkupRaiseRequest setDiscipline(String value) { this.Discipline = value; return this; }
        public Date getDueDate() { return DueDate; }
        public MarkupRaiseRequest setDueDate(Date value) { this.DueDate = value; return this; }
    }

    public static class MarkupRaiseResponse
    {
        public ResponseStatus ResponseStatus = null;
        public DocumentMarkupLink Link = null;
        public ArrayList<DocumentMarkupLink> Links = new ArrayList<DocumentMarkupLink>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public MarkupRaiseResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public DocumentMarkupLink getLink() { return Link; }
        public MarkupRaiseResponse setLink(DocumentMarkupLink value) { this.Link = value; return this; }
        public ArrayList<DocumentMarkupLink> getLinks() { return Links; }
        public MarkupRaiseResponse setLinks(ArrayList<DocumentMarkupLink> value) { this.Links = value; return this; }
    }

    public static class DocumentMarkupLink
    {
        public Integer DocumentMarkupLinkID = null;
        public UUID AttachmentId = null;
        public Integer VersionNo = null;
        public Integer PageIndex = null;
        public String ShapeId = null;
        public String EntityType = null;
        public Integer EntityID = null;
        public String EntityNo = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        
        public Integer getDocumentMarkupLinkID() { return DocumentMarkupLinkID; }
        public DocumentMarkupLink setDocumentMarkupLinkID(Integer value) { this.DocumentMarkupLinkID = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public DocumentMarkupLink setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public DocumentMarkupLink setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getPageIndex() { return PageIndex; }
        public DocumentMarkupLink setPageIndex(Integer value) { this.PageIndex = value; return this; }
        public String getShapeId() { return ShapeId; }
        public DocumentMarkupLink setShapeId(String value) { this.ShapeId = value; return this; }
        public String getEntityType() { return EntityType; }
        public DocumentMarkupLink setEntityType(String value) { this.EntityType = value; return this; }
        public Integer getEntityID() { return EntityID; }
        public DocumentMarkupLink setEntityID(Integer value) { this.EntityID = value; return this; }
        public String getEntityNo() { return EntityNo; }
        public DocumentMarkupLink setEntityNo(String value) { this.EntityNo = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public DocumentMarkupLink setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public DocumentMarkupLink setCreatedAt(Date value) { this.CreatedAt = value; return this; }
    }

}

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