Versions Compared

Version Old Version 3 New Version 4
Changes made by

Pedro Jose Sanchez Luling

Pedro Jose Sanchez Luling

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Modifies the contents of an existing LIBRARY RESOURCE object

Input

parameters:

  • session: is the session token obtained in the session_init() call
  • resource_id: is a LIBRARY RESOURCE reference. If NULL, then the function will create a new LIBRARY resource, otherwise it will modify the existing LIBRARY RESOURCE identified by the parameter 'ref'
  • resource_data: XML containing the information to be modified (see LIBRARY RESOURCE OBJECT)

If a property of the LIBRARY RESOURCE is not specified in the resource_data XML will not be modified. If you want to remove the value of a property, it must be specified in the XML with an empty value.

Output

parameters:

  • result: XML with all the properties of the created/modified LIBRARY RESOURCE except the array of bytes
  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

The following example modifies the resource with reference 344 to set an empty description and a 'png' mime type. The rest of properties are not modified (scope, bytes...)

library_resource_get ( “LCAAAAAAAAAAAA”, 344,

Code Block
languagexml
<library_resource>
    <description>Description of the resource</description>
    <mime_type>png</mime_type>
    <code>code28</code>
    <bytes>aasdjasd98asduhasdkjhas</bytes>
<library_resource>

);

Response

sample:


Code Block
languagexml
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
    <library_resource>
        <ref>77</ref>
        <description>Description of the resource</description>
        <mime_type>image/png</mime_type>
        <code>code28</code>
        <scope>PROGRAM</scope>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>


Notes:

Remember that the byte contents of the resource must be Base64 encoded. Otherwise an error will be returned

Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to use the requested resource.

Normally this means that it is trying to generate a 'GLOBAL' scoped object but the Session user is not a System Administrator

WRONG_PARAMS

Any of the parameters supplied is invalid. The following situations will generate this error:

  • resource_data = null
  • Any of the values provided in resource_data is not valid (e.g. an unsupported scope value)

XML_ERROR

The format of the resource_data parameter is not a valid XML

LIBRARY_RESOURCE_.NOT_FOUND

The resource_id parameter is not an existing LIBRARY RESOURCE reference provided does not correspond to an existing resource

LIBRARY_RESOURCE.BASE64ENCODING_EXPECTED

The bytes of the resource are expected to be Base64 encoded, but an invalid string has been supplied