Wiki

Case Status Kiln
Log In

Wiki

 
Retrieve an icon
  • RSS Feed

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

Tags:

Retrieve an icon

Context:     
        Client wants to get an icon
    URL:    
        https://api.intelligencebank.com/webapp/1.0/icon

    Method
        GET
       Parameters
        p10: {client api key}
        p20: {user uuid}
        type : { folder | people | file }
        name : { fileuuid  | folderuuid | useruuid | 'folder' | 'people'}
        ext : { if type = file then the file extension e.g. JPG, PDF, MP3}

    Header:
        _aid: <app id>

       Response
        200 : Custom icon if available otherwise default icon
        401 : Access denied
        404 : File not found
        500 : Internal server error

       Actions
        Process the streamed file
    
    Notes
        1. If a name is provided but a custom icon cannot be found, and a client default icon cannot be found then the default icon for the type is returned.
        2. If the name and type and ext parameters are missing it will return the default resource icon
        3. If a name is provided and the type is set to file and a valid ext is provided, then the ext icon is returned, otherwise the default resource icon is returned.