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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentMarkupLink() = 
        member val DocumentMarkupLinkID:Int32 = new Int32() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val PageIndex:Int32 = new Int32() with get,set
        member val ShapeId:String = null with get,set
        member val EntityType:String = null with get,set
        member val EntityID:Int32 = new Int32() with get,set
        member val EntityNo:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MarkupRaiseResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Link:DocumentMarkupLink = null with get,set
        member val Links:ResizeArray<DocumentMarkupLink> = new ResizeArray<DocumentMarkupLink>() with get,set

    [<AllowNullLiteral>]
    type MarkupRaiseRequest() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val PageIndex:Int32 = new Int32() with get,set
        member val ShapeId:String = null with get,set
        member val Raise:String = null with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val Area:String = null with get,set
        member val Trade:String = null with get,set
        member val AssignedSub:String = null with get,set
        member val Priority:String = null with get,set
        member val AskedOf:String = null with get,set
        member val Discipline:String = null with get,set
        member val DueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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"}]}