Jump to Content

Guides Discussions

Create Annotations

You can create Document Annotation from here

api/Viewer/CreateUpdateAnnotation

Query String

Parameter	Required	Value

Request Header

Parameter	Required	Value
Content-Type	Mandatory	application/json
TokenKey	Mandatory	User Input
PINProjectID	Mandatory	User Input
Accept-Encoding	Optional	gzip
Accept-Language	Optional	en-US

Request Body

Parameter	Required	Value
AnnotationName	Mandatory	User Input
SecondaryObjectID	Optional	User Input
RefObjectType	Optional	User Input
RefObjectId	Optional	User Input
PINProjectID	Mandatory	User Input
PageNo	Mandatory	User Input
OriginalFileName	Mandatory	User Input
ObjectType	Mandatory	User Input
ObjectID	Mandatory	User Input
IsPublic	Optional	User Input
IsLocked	Optional	User Input
HyperlinkExist	Optional	User Input
HyperlinkCount	Optional	User Input
Width	Optional	User Input
Height	Optional	User Input
CreateBy	Mandatory	User Input
ClientRefID	Optional	User Input
AnnotationJson	Optional	User Input

Example : Request Body

Response

ObjectAnnotationID: XXX-XXX

Enum : Object Type

Property Name	Description
1 - Documents	Project Files
2 - Attachment	Attached Documents

Enum : Ref Object Type

Property Name	Description
0 - None	None
1 - RFI	RFI
2 - Photo	Photo
3 - PunchList	Punch List
4 - PreExistHyperlink	Pre- Existing Hyper Link
5 - AutoHyperlink	Auto-Hyper Link

Document Annotation Entity

Property Name	Type
ObjectAnnotationID	Integer
PINProjectID	Integer
ObjectID	Integer
ObjectType	Integer
SecondaryObjectID	Integer
PageNo	Integer
AnnotationCount	Integer
RefObjectId	Integer
RefObjectType	Integer
ClientRefID	Integer
HyperlinkCount	Integer
CreateBy	Integer
ModifyBy	Integer
FirstName	String
LastName	String
CreateByName	String
CreateDate	Date Time
ModifyDate	Date Time
Height	Decimal
Width	Decimal
IsPublic	Boolean
IsLocked	Boolean
HyperlinkExist	Boolean
IsDeleted	Boolean
AnnotationName	String
AnnotationJson	String
DeviceAnnotationJson	String
OriginalFileName	String
MarkupData	String
MarkupJsonData	String

Remarks

Updated less than a minute ago