| POST,OPTIONS | /v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} |
|---|
import Foundation
import ServiceStack
public class MarkupRaiseRequest : Codable
{
public var attachmentId:String
public var versionNo:Int
public var pageIndex:Int
public var shapeId:String
public var raise:String
public var projectID:Int?
public var title:String
public var Description:String
public var area:String
public var trade:String
public var assignedSub:String
public var priority:String
public var askedOf:String
public var discipline:String
public var dueDate:Date?
required public init(){}
}
public class MarkupRaiseResponse : Codable
{
public var responseStatus:ResponseStatus
public var link:DocumentMarkupLink
public var links:[DocumentMarkupLink] = []
required public init(){}
}
public class DocumentMarkupLink : Codable
{
public var documentMarkupLinkID:Int
public var attachmentId:String
public var versionNo:Int
public var pageIndex:Int
public var shapeId:String
public var entityType:String
public var entityID:Int
public var entityNo:String
public var createdBy:String
public var createdAt:Date?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}