NGOGetAnnotationGroupProperty

This transaction can be used to get the properties for a particular Annotation of an Annotations Group.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOGet

Annotation

GroupProperty

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

The name of the cabinet.

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

Unique Index of the document.

Integer >= 0

N/A

PageNo

Root

The Page Number containing the Annotation Group whose annotations’ properties have to be fetched.

Integer >= 1 and <= Total pages

 

0

AnnotationIndex

Root

Index of the Annotaion for which we are seeking annotation property

Index of the annotion

 

0

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If the Status is 0, then the call is successful.

AccessType

Root

Type of Access on the Annotations. S – shared

I – inherited, P – Private

AnnotGroupIndex

Root

The index of the Annotations Group.

AnnotationType

Root

Type of Annotation. If no value is returned, then the Annotations are Image Annotations. If  ‘N’ is returned then it is Text Annotation (Notes).

PageNo

Root

The Page Number to which the Annotations belong.

AnnotGroupName

Root

Name of the Annotations Group.

CreationDateTime

Root

Date and Time at which the specified Annotations Group was created.

AnnotationBuffer

Root

The actual Annotation Data.

LoginUserRights

Root

The Rights of currently logged in User who has retrieved the Annotations Group’s properties.

AnnotationData

Root

The Annotation Data.

Owner

Root

Owner of the specified Annotations Group.

RevisedDateTime

Root

The Date and Time at which the Annotations Group was modified.

FinalizedDateTime

Root

The Date and Time at which the Annotations Group was finalized.

FinalizedBy

Root

The name of the User who finalized the Annotations Group.

FinalizedFlag

Root

Indicates whether the object is finalized or not.

Owner

Root

Name of the Owner.

FinalizedByUser

Root

The name of the User who finalized the Annotations Group.

 

Errors returned from call

Code

Message

Comments

-50025

Document not found.

Document with the specified Document Index does not exist.