Difference between revisions of "UBIK Content Web Service"

Revision as of 07:35, 30 June 2015

IIS Configuration

• In the Application Pool that runs the service, set the Advanced Setting "Load User Profile" to true

WebService methods

• ContextDefinitions[] GetContexts (applicationID)

Delivers a list of all useable Context objects for the given ApplicationID.

• DataShipment[] GetInfraStructure(deviceID, applicationID, contextID)

Delivers a list of basic content objects needed to be updated for the given application and given context on the given device (e.g. a list of all TAG objects incl. properties that changed since the last infrastructure update).

• DataShipment[] GetDefaultInfraStructure(deviceID, applicationID)

Delivers a list of basic content objects needed to be updated for the given application and its default context on the given device (e.g. a list of all TAG objects incl. properties that changed since the last infrastructure update).

• DataShipment GetContent (id, context, lock)

Delivers a content object with the given primary key (id). The scope defines the collection of properties that are delivered together with the content object. If the lock parameter is false, only read access is granted, if the lock parameter is true, the system grants write access for the given content object (all properties for the given context are marked as locked on the server side).

• ids[] GetNextContentLevelIds (contextID, ownerID)

Delivers a list of the ids for the next viewLevel for the given owner object.

• DataShipment[] GetNextContentLevel (contextID, ownerID)

Delivers a list of content objects for the next content level in the given context (uses the view of the context) for the given owner object. The context defines scope the collection of properties that are delivered together with the content object. Only read access is granted.

• UpdateContentClass(ContractID, ID, dataobject)

Updates the content with the given ID. To perform an update a valid contractID is necessary. After a successful update the contractID looses its validity.

• DataShipment CreateNewContent(contextID, contentID)

Creates a new updateable (incl. valid data contract) content record. This record is sent back to the client and can be updated via UpdateContentClass.