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}

export class DocumentMarkupLink
{
    public DocumentMarkupLinkID: number;
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public ShapeId: string;
    public EntityType: string;
    public EntityID: number;
    public EntityNo: string;
    public CreatedBy: string;
    public CreatedAt?: string;

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

export class MarkupRaiseResponse
{
    public ResponseStatus: ResponseStatus;
    public Link: DocumentMarkupLink;
    public Links: DocumentMarkupLink[] = [];

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

export class MarkupRaiseRequest
{
    public AttachmentId: string;
    public VersionNo: number;
    public PageIndex: number;
    public ShapeId: string;
    public Raise: string;
    public ProjectID?: number;
    public Title: string;
    public Description: string;
    public Area: string;
    public Trade: string;
    public AssignedSub: string;
    public Priority: string;
    public AskedOf: string;
    public Discipline: string;
    public DueDate?: string;

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

TypeScript MarkupRaiseRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000"},"Links":[{"DocumentMarkupLinkID":0,"AttachmentId":"00000000000000000000000000000000","VersionNo":0,"PageIndex":0,"ShapeId":"String","EntityType":"String","EntityID":0,"EntityNo":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000"}]}