3.1.4.1 CreateAnnotation

  • Article

The CreateAnnotation operation is used to create an Annotation complex type (section 2.2.4.18) on the server (2).

The following is the WSDL port type specification of the CreateAnnotation WSDL operation.

 <wsdl:operation name="CreateAnnotation" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input message="tns:CreateAnnotationSoapIn"/>
   <wsdl:output message="tns:CreateAnnotationSoapOut"/>
 </wsdl:operation>

The protocol client sends a CreateAnnotationSoapIn request message (section 3.1.4.1.1.1), and the server (2) responds with a CreateAnnotationSoapOut response message (section 3.1.4.1.1.2) as follows:

  • The protocol client MUST send the Annotation to be created.

  • The server (2) MUST create the specified Annotation in the database.

  • If creation is successful, the server (2) MUST return the created Annotation whose following fields are updated:

    • CreatedOn

    • Guid

    • LastUpdatedOn

Exceptions:

ErrorCode

Description

AnnotationNotEnabled

See Full List of Possible Error Codes (section 2.2.2.1.2).

InvalidAnnotation

See Full List of Possible Error Codes (section 2.2.2.1.2).

InvalidComment

See Common List of Error Codes (section 2.2.2.1.3).

InvalidPermission

See Common List of Error Codes (section 2.2.2.1.3).

In case of any other failure, the ErrorCode MUST be one of the values specified in section 2.2.2.1.2. A detailed specification of how exceptions are reported by the server (2) is in section 2.2.2.1.