OData Class

Properties   Methods   Events   Configuration Settings   Errors  

The OData component implements the Open Data Protocol (OData). It can be used to query, parse, and update/modify data contained within an OData service.

Class Name

IPWorks_OData

Procedural Interface

 ipworks_odata_open();
 ipworks_odata_close($res);
 ipworks_odata_register_callback($res, $id, $function);
 ipworks_odata_get_last_error($res);
 ipworks_odata_get_last_error_code($res);
 ipworks_odata_set($res, $id, $index, $value);
 ipworks_odata_get($res, $id, $index);
 ipworks_odata_do_config($res, $configurationstring);
 ipworks_odata_do_createentry($res);
 ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata);
 ipworks_odata_do_deleteentry($res);
 ipworks_odata_do_getentryproperty($res, $xpath);
 ipworks_odata_do_getschema($res);
 ipworks_odata_do_hasxpath($res, $xpath);
 ipworks_odata_do_queryservice($res);
 ipworks_odata_do_reset($res);
 ipworks_odata_do_setentryproperty($res, $xpath, $value);
 ipworks_odata_do_setschemaentity($res, $name);
 ipworks_odata_do_setschemaproperty($res, $name);
 ipworks_odata_do_setschematype($res, $name);
 ipworks_odata_do_updateentry($res);
 ipworks_odata_do_updateproperty($res, $xpath, $value);

Remarks

The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. QueryService can then be called to retrieve the results (which can be viewed via the Entry*** properties).

  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.ResourcePath = "Products"
  OData1.QueryService()

To create a new entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. CreateEntry can then be called to create the entry.

  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.ResourcePath = "Products"
  OData1.EntryProperties
  OData1.CreateEntry()

If you wish to update an entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. UpdateEntry can then be called to update the entry.

  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.ResourcePath = "Products(1)"
  // Index 1 is the "Name" property.
  OData1.EntryProperties[1].Value = "MyNewName"
  OData1.UpdateEntry()

Deleting an entry requires that you first set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to delete. DeleteEntry can then be called to delete the entry.

  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.ResourcePath = "Products(1)"
  OData1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting ServiceRootURI to the root URI of the service, GetSchema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

  OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
  OData1.GetSchema()