Wiki

Case Status Kiln
Log In

Wiki

 
Retrieve an annotation
  • RSS Feed

Last modified on 2/08/2016 8:13 AM by User.

Tags:

Retrieve an annotation

Context:     
        User wants to get the annotations for a file
    URL:    
        https://api.intelligencebank.com/webapp/1.0/annotations

    Method
        GET
       Parameters
        p10: { api key}
        p20: { useruuid }
        fileuuid: { file uuid }
        OPTIONAL: version: { version number of resource}

    Header:
        _aid: <app id>
        
       Response
        200 :
                <response>
                    <annotation>
                        <annotationid>{ annotation id number }</annotationid>
                        <annotationdata>{ annotation data }</annotationdata>
                        <privacytype>{ privacytype - should be private }</privacytype>
                        <createdat>{ created at }</createdat>
                        <updatedat>{ updated at}</updatedat>
                    </annotation>
                    </response>
        401 : Access denied
        404 : Annotation not found
        500 : Internal server error

       Actions
        Process the annotation

    Notes: