OData Class

Properties   Methods   Events   Config Settings   Errors  

The OData class implements the Open Data Protocol (OData). It can be used to query, parse, and update or 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 Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

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).

Example 1. Query a Service: 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.

Example 2. Create a New 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.

Example 3. Update an 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.

Example 4. Delete an 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.

Example 5. Retrieve the Scheme: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.GetSchema()

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Authorization Property (IPWorks_OData Class)

This property includes the Authorization string to be sent to the server.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

ipworks_odata_get($res, 1 );
ipworks_odata_set($res, 1, $value );

Default Value

''

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (IPWorks_OData Class)

This property specifies the authentication scheme to use when server authentication is required.

Object Oriented Interface

public function getAuthScheme();
public function setAuthScheme($value);

Procedural Interface

ipworks_odata_get($res, 2 );
ipworks_odata_set($res, 2, $value );

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

Data Type

Integer

ChannelAuthorEmail Property (IPWorks_OData Class)

This property contains the email address of the author.

Object Oriented Interface

public function getChannelAuthorEmail();
public function setChannelAuthorEmail($value);

Procedural Interface

ipworks_odata_get($res, 3 );
ipworks_odata_set($res, 3, $value );

Default Value

''

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorName Property (IPWorks_OData Class)

This property contains the name of the author.

Object Oriented Interface

public function getChannelAuthorName();
public function setChannelAuthorName($value);

Procedural Interface

ipworks_odata_get($res, 4 );
ipworks_odata_set($res, 4, $value );

Default Value

''

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorUri Property (IPWorks_OData Class)

This property contains the uniform resource identifier (URI) of the author.

Object Oriented Interface

public function getChannelAuthorUri();
public function setChannelAuthorUri($value);

Procedural Interface

ipworks_odata_get($res, 5 );
ipworks_odata_set($res, 5, $value );

Default Value

''

Remarks

This property contains the uniform resource identifier (URI) of the author.

This property is not available at design time.

Data Type

String

ChannelCategoryLabel Property (IPWorks_OData Class)

This property contains a textual description of the label for the category.

Object Oriented Interface

public function getChannelCategoryLabel();
public function setChannelCategoryLabel($value);

Procedural Interface

ipworks_odata_get($res, 6 );
ipworks_odata_set($res, 6, $value );

Default Value

''

Remarks

This property contains a textual description of the label for the category.

This property is not available at design time.

Data Type

String

ChannelCategoryScheme Property (IPWorks_OData Class)

This property identifies a categorization scheme.

Object Oriented Interface

public function getChannelCategoryScheme();
public function setChannelCategoryScheme($value);

Procedural Interface

ipworks_odata_get($res, 7 );
ipworks_odata_set($res, 7, $value );

Default Value

''

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

ChannelCategoryTerm Property (IPWorks_OData Class)

This property contains the category to which the entry or feed belongs.

Object Oriented Interface

public function getChannelCategoryTerm();
public function setChannelCategoryTerm($value);

Procedural Interface

ipworks_odata_get($res, 8 );
ipworks_odata_set($res, 8, $value );

Default Value

''

Remarks

This property contains the category to which the entry or feed belongs.

This property is not available at design time.

Data Type

String

ChannelContributorEmail Property (IPWorks_OData Class)

This property contains the email address of the contributor.

Object Oriented Interface

public function getChannelContributorEmail();
public function setChannelContributorEmail($value);

Procedural Interface

ipworks_odata_get($res, 9 );
ipworks_odata_set($res, 9, $value );

Default Value

''

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorName Property (IPWorks_OData Class)

This property contains the name of the contributor.

Object Oriented Interface

public function getChannelContributorName();
public function setChannelContributorName($value);

Procedural Interface

ipworks_odata_get($res, 10 );
ipworks_odata_set($res, 10, $value );

Default Value

''

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorUri Property (IPWorks_OData Class)

This property contains the uniform resource identifier (URI) of the contributor.

Object Oriented Interface

public function getChannelContributorUri();
public function setChannelContributorUri($value);

Procedural Interface

ipworks_odata_get($res, 11 );
ipworks_odata_set($res, 11, $value );

Default Value

''

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

This property is not available at design time.

Data Type

String

ChannelGenerator Property (IPWorks_OData Class)

This property identifies the generator of the feed.

Object Oriented Interface

public function getChannelGenerator();
public function setChannelGenerator($value);

Procedural Interface

ipworks_odata_get($res, 12 );
ipworks_odata_set($res, 12, $value );

Default Value

''

Remarks

This property identifies the generator of the feed.

This property is not available at design time.

Data Type

String

ChannelIcon Property (IPWorks_OData Class)

This property contains a reference to the image that represents this feed.

Object Oriented Interface

public function getChannelIcon();
public function setChannelIcon($value);

Procedural Interface

ipworks_odata_get($res, 13 );
ipworks_odata_set($res, 13, $value );

Default Value

''

Remarks

This property contains a reference to the image that represents this feed.

This property is not available at design time.

Data Type

String

ChannelId Property (IPWorks_OData Class)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Object Oriented Interface

public function getChannelId();
public function setChannelId($value);

Procedural Interface

ipworks_odata_get($res, 14 );
ipworks_odata_set($res, 14, $value );

Default Value

''

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

Data Type

String

ChannelLinkHref Property (IPWorks_OData Class)

This property contains the location of the link.

Object Oriented Interface

public function getChannelLinkHref();
public function setChannelLinkHref($value);

Procedural Interface

ipworks_odata_get($res, 15 );
ipworks_odata_set($res, 15, $value );

Default Value

''

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

ChannelLinkHrefLang Property (IPWorks_OData Class)

This property contains the language of the content at the link.

Object Oriented Interface

public function getChannelLinkHrefLang();
public function setChannelLinkHrefLang($value);

Procedural Interface

ipworks_odata_get($res, 16 );
ipworks_odata_set($res, 16, $value );

Default Value

''

Remarks

This property contains the language of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkLength Property (IPWorks_OData Class)

This property contains the length (in bytes) of the content at the link.

Object Oriented Interface

public function getChannelLinkLength();
public function setChannelLinkLength($value);

Procedural Interface

ipworks_odata_get($res, 17 );
ipworks_odata_set($res, 17, $value );

Default Value

''

Remarks

This property contains the length (in bytes) of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkRel Property (IPWorks_OData Class)

This property indicates the relation of the linked content to the feed.

Object Oriented Interface

public function getChannelLinkRel();
public function setChannelLinkRel($value);

Procedural Interface

ipworks_odata_get($res, 18 );
ipworks_odata_set($res, 18, $value );

Default Value

''

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

This property is not available at design time.

Data Type

String

ChannelLinkTitle Property (IPWorks_OData Class)

This property contains the title of the link.

Object Oriented Interface

public function getChannelLinkTitle();
public function setChannelLinkTitle($value);

Procedural Interface

ipworks_odata_get($res, 19 );
ipworks_odata_set($res, 19, $value );

Default Value

''

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

ChannelLinkType Property (IPWorks_OData Class)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Object Oriented Interface

public function getChannelLinkType();
public function setChannelLinkType($value);

Procedural Interface

ipworks_odata_get($res, 20 );
ipworks_odata_set($res, 20, $value );

Default Value

''

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLogo Property (IPWorks_OData Class)

This property contains the logo for an image that represents the feed.

Object Oriented Interface

public function getChannelLogo();
public function setChannelLogo($value);

Procedural Interface

ipworks_odata_get($res, 21 );
ipworks_odata_set($res, 21, $value );

Default Value

''

Remarks

This property contains the logo for an image that represents the feed.

This property is not available at design time.

Data Type

String

ChannelRights Property (IPWorks_OData Class)

This property contains information about the rights of the given feed.

Object Oriented Interface

public function getChannelRights();
public function setChannelRights($value);

Procedural Interface

ipworks_odata_get($res, 22 );
ipworks_odata_set($res, 22, $value );

Default Value

''

Remarks

This property contains information about the rights of the given feed.

This property is not available at design time.

Data Type

String

ChannelRightsTextType Property (IPWorks_OData Class)

This property contains the text type of the rights of the feed.

Object Oriented Interface

public function getChannelRightsTextType();
public function setChannelRightsTextType($value);

Procedural Interface

ipworks_odata_get($res, 23 );
ipworks_odata_set($res, 23, $value );

Default Value

0

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelSubtitle Property (IPWorks_OData Class)

This property contains a short description of the Atom feed.

Object Oriented Interface

public function getChannelSubtitle();
public function setChannelSubtitle($value);

Procedural Interface

ipworks_odata_get($res, 24 );
ipworks_odata_set($res, 24, $value );

Default Value

''

Remarks

This property contains a short description of the Atom feed.

Data Type

String

ChannelSubtitleTextType Property (IPWorks_OData Class)

This property contains the text type of the subtitle of the feed.

Object Oriented Interface

public function getChannelSubtitleTextType();
public function setChannelSubtitleTextType($value);

Procedural Interface

ipworks_odata_get($res, 25 );
ipworks_odata_set($res, 25, $value );

Default Value

0

Remarks

This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelTitle Property (IPWorks_OData Class)

This property contains the title of the current Atom feed.

Object Oriented Interface

public function getChannelTitle();
public function setChannelTitle($value);

Procedural Interface

ipworks_odata_get($res, 26 );
ipworks_odata_set($res, 26, $value );

Default Value

''

Remarks

This property contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

Data Type

String

ChannelTitleTextType Property (IPWorks_OData Class)

This property contains the text type of the title of the feed.

Object Oriented Interface

public function getChannelTitleTextType();
public function setChannelTitleTextType($value);

Procedural Interface

ipworks_odata_get($res, 27 );
ipworks_odata_set($res, 27, $value );

Default Value

0

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelUpdated Property (IPWorks_OData Class)

This property contains the date and time that the feed was updated.

Object Oriented Interface

public function getChannelUpdated();
public function setChannelUpdated($value);

Procedural Interface

ipworks_odata_get($res, 28 );
ipworks_odata_set($res, 28, $value );

Default Value

''

Remarks

This property contains the date and time that the feed was updated.

Data Type

String

CookieCount Property (IPWorks_OData Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworks_odata_get($res, 29 );
ipworks_odata_set($res, 29, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (IPWorks_OData Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworks_odata_get($res, 30 , $cookieindex);

Default Value

''

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieExpiration Property (IPWorks_OData Class)

An expiration time for the cookie (if provided by the server).

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworks_odata_get($res, 31 , $cookieindex);

Default Value

''

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieName Property (IPWorks_OData Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworks_odata_get($res, 32 , $cookieindex);
ipworks_odata_set($res, 32, $value , $cookieindex);

Default Value

''

Remarks

The name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (IPWorks_OData Class)

A path name to limit the cookie to (if provided by the server).

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworks_odata_get($res, 33 , $cookieindex);

Default Value

''

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieSecure Property (IPWorks_OData Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworks_odata_get($res, 34 , $cookieindex);

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CookieValue Property (IPWorks_OData Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworks_odata_get($res, 35 , $cookieindex);
ipworks_odata_set($res, 35, $value , $cookieindex);

Default Value

''

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

EntryAuthor Property (IPWorks_OData Class)

This property includes the author of the current entry in an OData feed.

Object Oriented Interface

public function getEntryAuthor();
public function setEntryAuthor($value);

Procedural Interface

ipworks_odata_get($res, 36 );
ipworks_odata_set($res, 36, $value );

Default Value

''

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

Data Type

String

EntryCount Property (IPWorks_OData Class)

This property includes the number of entries contained within an OData feed.

Object Oriented Interface

public function getEntryCount();

Procedural Interface

ipworks_odata_get($res, 37 );

Default Value

0

Remarks

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

This property is read-only and not available at design time.

Data Type

Integer

EntryETag Property (IPWorks_OData Class)

This property includes the ETag of the current entry in an OData feed.

Object Oriented Interface

public function getEntryETag();
public function setEntryETag($value);

Procedural Interface

ipworks_odata_get($res, 38 );
ipworks_odata_set($res, 38, $value );

Default Value

''

Remarks

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the EntryIndex is set.

This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty string, an If-None-Match header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an If-Match header will be sent with the entered value.

This property is not available at design time.

Data Type

String

EntryId Property (IPWorks_OData Class)

This property includes the Id of the current entry in an OData feed.

Object Oriented Interface

public function getEntryId();
public function setEntryId($value);

Procedural Interface

ipworks_odata_get($res, 39 );
ipworks_odata_set($res, 39, $value );

Default Value

''

Remarks

This property contains the Id of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an Id can be found).

This property is not available at design time.

Data Type

String

EntryIndex Property (IPWorks_OData Class)

This property includes the index of the current entry in an OData feed.

Object Oriented Interface

public function getEntryIndex();
public function setEntryIndex($value);

Procedural Interface

ipworks_odata_get($res, 40 );
ipworks_odata_set($res, 40, $value );

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath will be populated with their respective values found within the entry.

This property takes index values from 0 to EntryCount -1.

Setting EntryIndex to -1 will clear the entries contained by the component and also will reset EntryProperties and EntryCount.

This property is not available at design time.

Data Type

Integer

EntryLinksCount Property (IPWorks_OData Class)

The number of records in the EntryLinks arrays.

Object Oriented Interface

public function getEntryLinksCount();
public function setEntryLinksCount($value);

Procedural Interface

ipworks_odata_get($res, 41 );
ipworks_odata_set($res, 41, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EntryLinksResourcePath
• EntryLinksTitle

The array indices start at 0 and end at EntryLinksCount - 1.

This property is not available at design time.

Data Type

Integer

EntryLinksResourcePath Property (IPWorks_OData Class)

This property contains the resource path of the OData entry element link.

Object Oriented Interface

public function getEntryLinksResourcePath($entrylinksindex);

Procedural Interface

ipworks_odata_get($res, 42 , $entrylinksindex);

Default Value

''

Remarks

This property contains the resource path of the OData entry element link.

By setting this value to ResourcePath and calling QueryService, you can retrieve the related entries of the current entry (as specified by EntryIndex).

The $entrylinksindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.

This property is read-only and not available at design time.

Data Type

String

EntryLinksTitle Property (IPWorks_OData Class)

This property contains the title of the OData entry element link.

Object Oriented Interface

public function getEntryLinksTitle($entrylinksindex);

Procedural Interface

ipworks_odata_get($res, 43 , $entrylinksindex);

Default Value

''

Remarks

This property contains the title of the OData entry element link.

The $entrylinksindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.

This property is read-only and not available at design time.

Data Type

String

EntryPropertiesCount Property (IPWorks_OData Class)

The number of records in the EntryProperties arrays.

Object Oriented Interface

public function getEntryPropertiesCount();
public function setEntryPropertiesCount($value);

Procedural Interface

ipworks_odata_get($res, 44 );
ipworks_odata_set($res, 44, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EntryPropertiesAttributes
• EntryPropertiesIsNull
• EntryPropertiesName
• EntryPropertiesType
• EntryPropertiesValue
• EntryPropertiesXPath

The array indices start at 0 and end at EntryPropertiesCount - 1.

This property is not available at design time.

Data Type

Integer

EntryPropertiesAttributes Property (IPWorks_OData Class)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element.

Object Oriented Interface

public function getEntryPropertiesAttributes($entrypropertiesindex);
public function setEntryPropertiesAttributes($entrypropertiesindex, $value);

Procedural Interface

ipworks_odata_get($res, 45 , $entrypropertiesindex);
ipworks_odata_set($res, 45, $value , $entrypropertiesindex);

Default Value

''

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is not available at design time.

Data Type

String

EntryPropertiesIsNull Property (IPWorks_OData Class)

This property indicates whether a property value of a primitive type is null.

Object Oriented Interface

public function getEntryPropertiesIsNull($entrypropertiesindex);
public function setEntryPropertiesIsNull($entrypropertiesindex, $value);

Procedural Interface

ipworks_odata_get($res, 46 , $entrypropertiesindex);
ipworks_odata_set($res, 46, $value , $entrypropertiesindex);

Default Value

false

Remarks

This property indicates whether a property value of a primitive type is null.

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is not available at design time.

Data Type

Boolean

EntryPropertiesName Property (IPWorks_OData Class)

This property contains the name of the OData entry element.

Object Oriented Interface

public function getEntryPropertiesName($entrypropertiesindex);
public function setEntryPropertiesName($entrypropertiesindex, $value);

Procedural Interface

ipworks_odata_get($res, 47 , $entrypropertiesindex);
ipworks_odata_set($res, 47, $value , $entrypropertiesindex);

Default Value

''

Remarks

This property contains the name of the OData entry element.

Note: For properties derived from a complex type, the name of the property and its subproperty will be separated by a slash (/). For example, let's say you have a property called MailingAddress that is derived from a complex type called Address. The Address complex type contains a property called City. This particular property will be returned as MailingAddress/City.

Setting this property to an empty string before calling UpdateEntry will result in the item not being sent in the update request, thus removing it from the OData entry.

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is not available at design time.

Data Type

String

EntryPropertiesType Property (IPWorks_OData Class)

This property contains the type of the OData schema property.

Object Oriented Interface

public function getEntryPropertiesType($entrypropertiesindex);
public function setEntryPropertiesType($entrypropertiesindex, $value);

Procedural Interface

ipworks_odata_get($res, 48 , $entrypropertiesindex);
ipworks_odata_set($res, 48, $value , $entrypropertiesindex);

Default Value

''

Remarks

This property contains the type of the OData schema property.

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is not available at design time.

Data Type

String

EntryPropertiesValue Property (IPWorks_OData Class)

This property contains the value of the OData entry element.

Object Oriented Interface

public function getEntryPropertiesValue($entrypropertiesindex);
public function setEntryPropertiesValue($entrypropertiesindex, $value);

Procedural Interface

ipworks_odata_get($res, 49 , $entrypropertiesindex);
ipworks_odata_set($res, 49, $value , $entrypropertiesindex);

Default Value

''

Remarks

This property contains the value of the OData entry element.

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is not available at design time.

Data Type

String

EntryPropertiesXPath Property (IPWorks_OData Class)

This property contains the XPath of the OData entry property.

Object Oriented Interface

public function getEntryPropertiesXPath($entrypropertiesindex);

Procedural Interface

ipworks_odata_get($res, 50 , $entrypropertiesindex);

Default Value

''

Remarks

This property contains the XPath of the OData entry property. This value can be used to set XPath or can be used within UpdateProperty to update a specific property.

The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.

This property is read-only and not available at design time.

Data Type

String

EntrySummary Property (IPWorks_OData Class)

This property includes a summary of the current entry in an OData feed.

Object Oriented Interface

public function getEntrySummary();
public function setEntrySummary($value);

Procedural Interface

ipworks_odata_get($res, 51 );
ipworks_odata_set($res, 51, $value );

Default Value

''

Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a summary can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

Data Type

String

EntryTitle Property (IPWorks_OData Class)

This property includes the title of the current entry in an OData feed.

Object Oriented Interface

public function getEntryTitle();
public function setEntryTitle($value);

Procedural Interface

ipworks_odata_get($res, 52 );
ipworks_odata_set($res, 52, $value );

Default Value

''

Remarks

This property contains the title of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a title can be found).

This property is not available at design time.

Data Type

String

EntryType Property (IPWorks_OData Class)

This property includes the entry category or type.

Object Oriented Interface

public function getEntryType();
public function setEntryType($value);

Procedural Interface

ipworks_odata_get($res, 53 );
ipworks_odata_set($res, 53, $value );

Default Value

''

Remarks

This property specifies the entry category or type. When communicating with a service using OData V3, this property specifies the category element. When communicating with a service using OData V4, this property specifies the type attribute.

This property is not available at design time.

Data Type

String

EntryUpdated Property (IPWorks_OData Class)

This property includes the date-time when a current entry in an OData feed was updated.

Object Oriented Interface

public function getEntryUpdated();

Procedural Interface

ipworks_odata_get($res, 54 );

Default Value

''

Remarks

This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a data-time can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

Data Type

String

EntryXML Property (IPWorks_OData Class)

This property includes the raw XML of the current entry in an OData feed.

Object Oriented Interface

public function getEntryXML();
public function setEntryXML($value);

Procedural Interface

ipworks_odata_get($res, 55 );
ipworks_odata_set($res, 55, $value );

Default Value

''

Remarks

This property contains the raw XML of a specified entry within an OData feed. This value will be populated once EntryIndex is set.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (IPWorks_OData Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_odata_get($res, 56 );
ipworks_odata_set($res, 56, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorks_OData Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_odata_get($res, 57 );
ipworks_odata_set($res, 57, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorks_OData Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_odata_get($res, 58 );
ipworks_odata_set($res, 58, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorks_OData Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworks_odata_get($res, 59 );
ipworks_odata_set($res, 59, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorks_OData Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_odata_get($res, 60 );
ipworks_odata_set($res, 60, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorks_OData Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_odata_get($res, 61 );
ipworks_odata_set($res, 61, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (IPWorks_OData Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_odata_get($res, 62 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (IPWorks_OData Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_odata_get($res, 63 );
ipworks_odata_set($res, 63, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

ODataVersion Property (IPWorks_OData Class)

This property includes the OData version.

Object Oriented Interface

public function getODataVersion();
public function setODataVersion($value);

Procedural Interface

ipworks_odata_get($res, 64 );
ipworks_odata_set($res, 64, $value );

Default Value

3

Remarks

This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:

• 0 (odV2)
• 1 (odv3)
• 3 (odV4)
• 4 (odAuto - default)

When set to 4 (odAuto - default), the class will automatically determine the version used by the service and use the same version to format requests and parse responses. When calling CreateEntry or UpdateEntry, if the service version is not already known from a previous operation, the class will first query the service to determine the version.

Once the version of the service has been automatically determined, it will continue to be used until Reset is called.

This property is not available at design time.

Data Type

Integer

OtherHeaders Property (IPWorks_OData Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_odata_get($res, 65 );
ipworks_odata_set($res, 65, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

OtherQueryOptions Property (IPWorks_OData Class)

This property includes additional query options to be used when querying a service.

Object Oriented Interface

public function getOtherQueryOptions();
public function setOtherQueryOptions($value);

Procedural Interface

ipworks_odata_get($res, 66 );
ipworks_odata_set($res, 66, $value );

Default Value

''

Remarks

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs, and multiple entries should be separated with an "&" (i.e., name1=value1&name2=value2).

Note: All specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI, ResourcePath, and any Query*** properties specified).

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (IPWorks_OData Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_odata_get($res, 67 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (IPWorks_OData Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

ipworks_odata_get($res, 68 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (IPWorks_OData Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_odata_get($res, 69 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

Password Property (IPWorks_OData Class)

This property includes a password if authentication is to be used.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworks_odata_get($res, 70 );
ipworks_odata_set($res, 70, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

ProxyAuthScheme Property (IPWorks_OData Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_odata_get($res, 71 );
ipworks_odata_set($res, 71, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (IPWorks_OData Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_odata_get($res, 72 );
ipworks_odata_set($res, 72, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorks_OData Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_odata_get($res, 73 );
ipworks_odata_set($res, 73, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (IPWorks_OData Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_odata_get($res, 74 );
ipworks_odata_set($res, 74, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (IPWorks_OData Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworks_odata_get($res, 75 );
ipworks_odata_set($res, 75, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (IPWorks_OData Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworks_odata_get($res, 76 );
ipworks_odata_set($res, 76, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (IPWorks_OData Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_odata_get($res, 77 );
ipworks_odata_set($res, 77, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryFilter Property (IPWorks_OData Class)

This property selects only the entries that satisfy the specified filter (expression).

Object Oriented Interface

public function getQueryFilter();
public function setQueryFilter($value);

Procedural Interface

ipworks_odata_get($res, 78 );
ipworks_odata_set($res, 78, $value );

Default Value

''

Remarks

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

The following operators are supported in the expression language.

Logical Operators

Arithmetic Operators

Grouping Operators

The following functions are supported in the expression language.

String Functions

Date Functions

Math Functions

Type Functions

This property is not available at design time.

Data Type

String

QueryOrderBy Property (IPWorks_OData Class)

This property includes the value used to order entries when querying a service.

Object Oriented Interface

public function getQueryOrderBy();
public function setQueryOrderBy($value);

Procedural Interface

ipworks_odata_get($res, 79 );
ipworks_odata_set($res, 79, $value );

Default Value

''

Remarks

This property allows you to specify a value by which the returned entries will be ordered after a call to QueryService.

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending asc or desc (respectively) to your OrderBy value. For example, if you want to sort the entries by Rating in descending order you would set QueryOrderBy to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.

This property is not available at design time.

Data Type

String

QuerySelect Property (IPWorks_OData Class)

This property selects only the specified properties to be returned in an entry when querying a service.

Object Oriented Interface

public function getQuerySelect();
public function setQuerySelect($value);

Procedural Interface

ipworks_odata_get($res, 80 );
ipworks_odata_set($res, 80, $value );

Default Value

''

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling QueryService. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to have only the Name and Price of each item returned you can set QuerySelect to Name,Price.

Note: The specified values can be a property name, navigation property name (EntryLinksTitle), or the "*" character, which returns all the properties for each entry.

This property is not available at design time.

Data Type

String

QuerySkip Property (IPWorks_OData Class)

This property includes the number of entries to skip when querying a service.

Object Oriented Interface

public function getQuerySkip();
public function setQuerySkip($value);

Procedural Interface

ipworks_odata_get($res, 81 );
ipworks_odata_set($res, 81, $value );

Default Value

''

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before skipping the top N items.

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to Rating desc (to order the items by Rating from highest to lowest), set QuerySkip to 2 (to skip the first and second items), and finally set QueryTop to 2 (to return only the third and fourth items).

This property is not available at design time.

Data Type

String

QuerySkipToken Property (IPWorks_OData Class)

This property includes the token given by an OData server when the last query result collection is too large.

Object Oriented Interface

public function getQuerySkipToken();
public function setQuerySkipToken($value);

Procedural Interface

ipworks_odata_get($res, 82 );
ipworks_odata_set($res, 82, $value );

Default Value

''

Remarks

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs, a Skip Token is returned in the response and the component will populate QuerySkipToken with the returned value. Calling QueryService again will return the next page of results.

This property is not available at design time.

Data Type

String

QueryTop Property (IPWorks_OData Class)

This property selects the first N entries when querying a service.

Object Oriented Interface

public function getQueryTop();
public function setQueryTop($value);

Procedural Interface

ipworks_odata_get($res, 83 );
ipworks_odata_set($res, 83, $value );

Default Value

''

Remarks

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before selecting the top N items.

This property is not available at design time.

Data Type

String

ResourcePath Property (IPWorks_OData Class)

This property includes the resource path of an OData service.

Object Oriented Interface

public function getResourcePath();
public function setResourcePath($value);

Procedural Interface

ipworks_odata_get($res, 84 );
ipworks_odata_set($res, 84, $value );

Default Value

''

Remarks

This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI (ServiceRootURI/ResourcePath) to query feeds and modify entries.

This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different resource path.

For example, a valid ResourcePath for the OData sample service is Products.

This property is not available at design time.

Data Type

String

SchemaAssociationContainsTarget Property (IPWorks_OData Class)

This property indicates whether the navigation property contains a target.

Object Oriented Interface

public function getSchemaAssociationContainsTarget();

Procedural Interface

ipworks_odata_get($res, 85 );

Default Value

false

Remarks

This property indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaAssociationDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema association.

Object Oriented Interface

public function getSchemaAssociationDescription();

Procedural Interface

ipworks_odata_get($res, 86 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationFromRole Property (IPWorks_OData Class)

This property contains the name of the starting point of the navigation.

Object Oriented Interface

public function getSchemaAssociationFromRole();

Procedural Interface

ipworks_odata_get($res, 87 );

Default Value

''

Remarks

This property contains the name of the starting point of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationFromRoleDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema FromRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationFromRoleDescription();

Procedural Interface

ipworks_odata_get($res, 88 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationFromRoleEntity Property (IPWorks_OData Class)

This property contains the name of the entity that the FromRole association endpoint maps to.

Object Oriented Interface

public function getSchemaAssociationFromRoleEntity();

Procedural Interface

ipworks_odata_get($res, 89 );

Default Value

''

Remarks

This property contains the name of the entity that the SchemaAssociationFromRole association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationFromRoleMultiplicity Property (IPWorks_OData Class)

This property contains the multiplicity of the FromRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationFromRoleMultiplicity();

Procedural Interface

ipworks_odata_get($res, 90 );

Default Value

0

Remarks

This property contains the multiplicity of the SchemaAssociationFromRole association endpoint. This is used along with SchemaAssociationToRoleMultiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Integer

SchemaAssociationFromRoleSummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema FromRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationFromRoleSummary();

Procedural Interface

ipworks_odata_get($res, 91 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema FromRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationName Property (IPWorks_OData Class)

This property contains the name of the OData schema navigation property.

Object Oriented Interface

public function getSchemaAssociationName();

Procedural Interface

ipworks_odata_get($res, 92 );

Default Value

''

Remarks

This property contains the name of the OData schema navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationNullable Property (IPWorks_OData Class)

This property indicates whether the property defined by the schema can be a null value.

Object Oriented Interface

public function getSchemaAssociationNullable();

Procedural Interface

ipworks_odata_get($res, 93 );

Default Value

true

Remarks

This property indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaAssociationOnDelete Property (IPWorks_OData Class)

This property contains the delete action to be performed.

Object Oriented Interface

public function getSchemaAssociationOnDelete();

Procedural Interface

ipworks_odata_get($res, 94 );

Default Value

0

Remarks

This property contains the delete action to be performed.

The possible values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Integer

SchemaAssociationPartner Property (IPWorks_OData Class)

This property contains the partner value identifying a navigation property (if any).

Object Oriented Interface

public function getSchemaAssociationPartner();

Procedural Interface

ipworks_odata_get($res, 95 );

Default Value

''

Remarks

This property contains the partner value identifying a navigation property (if any).

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationRefConstraintCount Property (IPWorks_OData Class)

This property contains the number of referential constraints.

Object Oriented Interface

public function getSchemaAssociationRefConstraintCount();

Procedural Interface

ipworks_odata_get($res, 96 );

Default Value

0

Remarks

This property contains the number of referential constraints. To examine the individual referential constraints set SchemaAssociationRefConstraintIndex to a value from 0 to SchemaAssociationRefConstraintCount -1. Example. Referential Constraints: For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1 odata.SchemaAssociation.RefConstraintIndex = i; Console.Write(odata.SchemaAssociation.RefConstraintProperty); Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty); Next i

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Integer

SchemaAssociationRefConstraintIndex Property (IPWorks_OData Class)

This property contains the current index of the referential constraint.

Object Oriented Interface

public function getSchemaAssociationRefConstraintIndex();
public function setSchemaAssociationRefConstraintIndex($value);

Procedural Interface

ipworks_odata_get($res, 97 );
ipworks_odata_set($res, 97, $value );

Default Value

0

Remarks

This property contains the current index of the referential constraint. See SchemaAssociationRefConstraintCount for details.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is not available at design time.

Data Type

Integer

SchemaAssociationRefConstraintProperty Property (IPWorks_OData Class)

This property contains the property that takes part in the referential constraint.

Object Oriented Interface

public function getSchemaAssociationRefConstraintProperty();

Procedural Interface

ipworks_odata_get($res, 98 );

Default Value

''

Remarks

This property contains the property that takes part in the referential constraint.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationRefConstraintReferencedProperty Property (IPWorks_OData Class)

This property contains the corresponding property of the principal entity type.

Object Oriented Interface

public function getSchemaAssociationRefConstraintReferencedProperty();

Procedural Interface

ipworks_odata_get($res, 99 );

Default Value

''

Remarks

This property contains the corresponding property of the principal entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationRelationship Property (IPWorks_OData Class)

This property contains the name of the relationship (association) of the navigation property.

Object Oriented Interface

public function getSchemaAssociationRelationship();

Procedural Interface

ipworks_odata_get($res, 100 );

Default Value

''

Remarks

This property contains the name of the relationship (association) of the navigation property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationSummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema association.

Object Oriented Interface

public function getSchemaAssociationSummary();

Procedural Interface

ipworks_odata_get($res, 101 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema association.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationToRole Property (IPWorks_OData Class)

This property contains the name of the endpoint of the navigation.

Object Oriented Interface

public function getSchemaAssociationToRole();

Procedural Interface

ipworks_odata_get($res, 102 );

Default Value

''

Remarks

This property contains the name of the endpoint of the navigation.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationToRoleDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema ToRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationToRoleDescription();

Procedural Interface

ipworks_odata_get($res, 103 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationToRoleEntity Property (IPWorks_OData Class)

This property contains the name of the entity that the ToRole association endpoint maps to.

Object Oriented Interface

public function getSchemaAssociationToRoleEntity();

Procedural Interface

ipworks_odata_get($res, 104 );

Default Value

''

Remarks

This property contains the name of the entity that the SchemaAssociationToRole association endpoint maps to.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationToRoleMultiplicity Property (IPWorks_OData Class)

This property contains the multiplicity of the ToRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationToRoleMultiplicity();

Procedural Interface

ipworks_odata_get($res, 105 );

Default Value

0

Remarks

This property contains the multiplicity of the SchemaAssociationToRole association endpoint. This is used along with SchemaAssociationFromRoleMultiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).

The available values are as follows:

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

Integer

SchemaAssociationToRoleSummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema ToRole association endpoint.

Object Oriented Interface

public function getSchemaAssociationToRoleSummary();

Procedural Interface

ipworks_odata_get($res, 106 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema ToRole association endpoint.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationType Property (IPWorks_OData Class)

This property contains the entity type.

Object Oriented Interface

public function getSchemaAssociationType();

Procedural Interface

ipworks_odata_get($res, 107 );

Default Value

''

Remarks

This property contains the entity type.

This property is applicable only to OData Version 4.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaAssociationCount Property (IPWorks_OData Class)

This property includes the number of navigation properties contained within an OData schema entity.

Object Oriented Interface

public function getSchemaAssociationCount();

Procedural Interface

ipworks_odata_get($res, 108 );

Default Value

0

Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

Data Type

Integer

SchemaAssociationIndex Property (IPWorks_OData Class)

This property includes the index of the current navigation property in an OData schema entity.

Object Oriented Interface

public function getSchemaAssociationIndex();
public function setSchemaAssociationIndex($value);

Procedural Interface

ipworks_odata_get($res, 109 );
ipworks_odata_set($res, 109, $value );

Default Value

0

Remarks

This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex). Once set, SchemaAssociation will be populated.

This property is not available at design time.

Data Type

Integer

SchemaEntityDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema entity.

Object Oriented Interface

public function getSchemaEntityDescription();

Procedural Interface

ipworks_odata_get($res, 110 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaEntityName Property (IPWorks_OData Class)

This property contains the name of the OData schema entity.

Object Oriented Interface

public function getSchemaEntityName();

Procedural Interface

ipworks_odata_get($res, 111 );

Default Value

''

Remarks

This property contains the name of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaEntitySummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema entity.

Object Oriented Interface

public function getSchemaEntitySummary();

Procedural Interface

ipworks_odata_get($res, 112 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema entity.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaEntityCount Property (IPWorks_OData Class)

This property includes the number of entities contained within an OData schema.

Object Oriented Interface

public function getSchemaEntityCount();

Procedural Interface

ipworks_odata_get($res, 113 );

Default Value

0

Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via GetSchema).

This property is read-only and not available at design time.

Data Type

Integer

SchemaEntityIndex Property (IPWorks_OData Class)

This property includes the index of the current entity in an OData schema.

Object Oriented Interface

public function getSchemaEntityIndex();
public function setSchemaEntityIndex($value);

Procedural Interface

ipworks_odata_get($res, 114 );
ipworks_odata_set($res, 114, $value );

Default Value

0

Remarks

This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.

This property is not available at design time.

Data Type

Integer

SchemaKeysCount Property (IPWorks_OData Class)

The number of records in the SchemaKeys array.

Object Oriented Interface

public function getSchemaKeysCount();

Procedural Interface

ipworks_odata_get($res, 115 );

Default Value

0

Remarks

This property is read-only and not available at design time.

Data Type

Integer

SchemaKeys Property (IPWorks_OData Class)

This property includes the keys for a schema entity.

Object Oriented Interface

public function getSchemaKeys($schemakeysindex);

Procedural Interface

ipworks_odata_get($res, 116 , $schemakeysindex);

Default Value

'0'

Remarks

This property is used to obtain the keys contained within an entity for a service schema and is populated after setting SchemaEntityIndex.

Note: Key values map to a property of the entity, details of which can be retrieved via SchemaProperty.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyAttributes Property (IPWorks_OData Class)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Object Oriented Interface

public function getSchemaPropertyAttributes();

Procedural Interface

ipworks_odata_get($res, 117 );

Default Value

''

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema property.

Object Oriented Interface

public function getSchemaPropertyDescription();

Procedural Interface

ipworks_odata_get($res, 118 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyIsComplexType Property (IPWorks_OData Class)

This property indicates whether a property is derived from a complex type.

Object Oriented Interface

public function getSchemaPropertyIsComplexType();

Procedural Interface

ipworks_odata_get($res, 119 );

Default Value

false

Remarks

This property indicates whether a property is derived from a complex type.

When set to True, SchemaTypeField can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaPropertyName Property (IPWorks_OData Class)

This property contains the Name of the OData schema property.

Object Oriented Interface

public function getSchemaPropertyName();

Procedural Interface

ipworks_odata_get($res, 120 );

Default Value

''

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyNullable Property (IPWorks_OData Class)

This property indicates whether a property can be null.

Object Oriented Interface

public function getSchemaPropertyNullable();

Procedural Interface

ipworks_odata_get($res, 121 );

Default Value

false

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaPropertySummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema property.

Object Oriented Interface

public function getSchemaPropertySummary();

Procedural Interface

ipworks_odata_get($res, 122 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyType Property (IPWorks_OData Class)

This property contains the type of the OData schema property.

Object Oriented Interface

public function getSchemaPropertyType();

Procedural Interface

ipworks_odata_get($res, 123 );

Default Value

''

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaPropertyCount Property (IPWorks_OData Class)

This property includes the number of properties contained within an OData schema entity.

Object Oriented Interface

public function getSchemaPropertyCount();

Procedural Interface

ipworks_odata_get($res, 124 );

Default Value

0

Remarks

This property is updated to reflect the total number of properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

Data Type

Integer

SchemaPropertyIndex Property (IPWorks_OData Class)

This property includes the index of the current property in an OData schema entity.

Object Oriented Interface

public function getSchemaPropertyIndex();
public function setSchemaPropertyIndex($value);

Procedural Interface

ipworks_odata_get($res, 125 );
ipworks_odata_set($res, 125, $value );

Default Value

0

Remarks

This property is used to specify a property within an entity (specified by SchemaEntityIndex). Once set, SchemaProperty will be populated.

This property is not available at design time.

Data Type

Integer

SchemaTypeFieldAttributes Property (IPWorks_OData Class)

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.

Object Oriented Interface

public function getSchemaTypeFieldAttributes();

Procedural Interface

ipworks_odata_get($res, 126 );

Default Value

''

Remarks

This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaTypeFieldDescription Property (IPWorks_OData Class)

This property contains the documentation long description of the OData schema property.

Object Oriented Interface

public function getSchemaTypeFieldDescription();

Procedural Interface

ipworks_odata_get($res, 127 );

Default Value

''

Remarks

This property contains the documentation long description of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaTypeFieldIsComplexType Property (IPWorks_OData Class)

This property indicates whether a property is derived from a complex type.

Object Oriented Interface

public function getSchemaTypeFieldIsComplexType();

Procedural Interface

ipworks_odata_get($res, 128 );

Default Value

false

Remarks

This property indicates whether a property is derived from a complex type.

When set to True, SchemaTypeField can be used to navigate the properties contained within the complex type.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaTypeFieldName Property (IPWorks_OData Class)

This property contains the Name of the OData schema property.

Object Oriented Interface

public function getSchemaTypeFieldName();

Procedural Interface

ipworks_odata_get($res, 129 );

Default Value

''

Remarks

This property contains the Name of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaTypeFieldNullable Property (IPWorks_OData Class)

This property indicates whether a property can be null.

Object Oriented Interface

public function getSchemaTypeFieldNullable();

Procedural Interface

ipworks_odata_get($res, 130 );

Default Value

false

Remarks

This property indicates whether a property can be null.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SchemaTypeFieldSummary Property (IPWorks_OData Class)

This property contains the documentation summary of the OData schema property.

Object Oriented Interface

public function getSchemaTypeFieldSummary();

Procedural Interface

ipworks_odata_get($res, 131 );

Default Value

''

Remarks

This property contains the documentation summary of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaTypeFieldType Property (IPWorks_OData Class)

This property contains the type of the OData schema property.

Object Oriented Interface

public function getSchemaTypeFieldType();

Procedural Interface

ipworks_odata_get($res, 132 );

Default Value

''

Remarks

This property contains the type of the OData schema property.

The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SchemaTypeFieldCount Property (IPWorks_OData Class)

This property includes the number of properties contained within an OData schema complex type.

Object Oriented Interface

public function getSchemaTypeFieldCount();

Procedural Interface

ipworks_odata_get($res, 133 );

Default Value

0

Remarks

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the type via SetSchemaType.

This property is read-only and not available at design time.

Data Type

Integer

SchemaTypeFieldIndex Property (IPWorks_OData Class)

This property includes the index of the current field (property) in an OData schema complex type.

Object Oriented Interface

public function getSchemaTypeFieldIndex();
public function setSchemaTypeFieldIndex($value);

Procedural Interface

ipworks_odata_get($res, 134 );
ipworks_odata_set($res, 134, $value );

Default Value

0

Remarks

This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

This property is not available at design time.

Data Type

Integer

ServiceRootURI Property (IPWorks_OData Class)

This property includes the root URI of an OData service.

Object Oriented Interface

public function getServiceRootURI();
public function setServiceRootURI($value);

Procedural Interface

ipworks_odata_get($res, 135 );
ipworks_odata_set($res, 135, $value );

Default Value

''

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) to query feeds and modify entries.

Example.

The ServiceRootURI of the OData sample service is "http://services.odata.org/OData/OData.svc/".

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorks_OData Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_odata_get($res, 136 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_OData Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_odata_get($res, 137 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_OData Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_odata_get($res, 138 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_OData Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_odata_get($res, 139 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_OData Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_odata_get($res, 140 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_OData Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_odata_get($res, 141 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_OData Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_odata_get($res, 142 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_OData Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_odata_get($res, 143 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_OData Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_odata_get($res, 144 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_OData Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_odata_get($res, 145 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_OData Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_odata_get($res, 146 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_OData Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_odata_get($res, 147 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_OData Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_odata_get($res, 148 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_OData Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_odata_get($res, 149 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_OData Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_odata_get($res, 150 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_OData Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_odata_get($res, 151 );
ipworks_odata_set($res, 151, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_OData Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_odata_get($res, 152 );
ipworks_odata_set($res, 152, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorks_OData Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_odata_get($res, 153 );
ipworks_odata_set($res, 153, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorks_OData Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_odata_get($res, 154 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_OData Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_odata_get($res, 155 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_OData Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_odata_get($res, 156 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_OData Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_odata_get($res, 157 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_OData Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_odata_get($res, 158 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_OData Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_odata_get($res, 159 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_OData Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_odata_get($res, 160 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_OData Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_odata_get($res, 161 );
ipworks_odata_set($res, 161, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_OData Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_odata_get($res, 162 );
ipworks_odata_set($res, 162, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorks_OData Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_odata_get($res, 163 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_OData Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_odata_get($res, 164 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_OData Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_odata_get($res, 165 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_OData Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_odata_get($res, 166 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_OData Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_odata_get($res, 167 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_OData Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_odata_get($res, 168 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_OData Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_odata_get($res, 169 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_OData Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_odata_get($res, 170 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_OData Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_odata_get($res, 171 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_OData Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_odata_get($res, 172 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_OData Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_odata_get($res, 173 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_OData Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_odata_get($res, 174 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_OData Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_odata_get($res, 175 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_OData Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_odata_get($res, 176 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_OData Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_odata_get($res, 177 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_OData Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_odata_get($res, 178 );
ipworks_odata_set($res, 178, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_OData Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworks_odata_get($res, 179 );
ipworks_odata_set($res, 179, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorks_OData Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_odata_get($res, 180 );
ipworks_odata_set($res, 180, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorks_OData Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_odata_get($res, 181 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_OData Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_odata_get($res, 182 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_OData Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_odata_get($res, 183 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_OData Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_odata_get($res, 184 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_OData Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_odata_get($res, 185 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_OData Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_odata_get($res, 186 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_OData Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_odata_get($res, 187 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_OData Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_odata_get($res, 188 );
ipworks_odata_set($res, 188, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorks_OData Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_odata_get($res, 189 );
ipworks_odata_set($res, 189, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorks_OData Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_odata_get($res, 190 );
ipworks_odata_set($res, 190, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorks_OData Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_odata_get($res, 191 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_OData Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_odata_get($res, 192 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_OData Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_odata_get($res, 193 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_OData Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_odata_get($res, 194 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_OData Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_odata_get($res, 195 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_OData Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_odata_get($res, 196 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_OData Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_odata_get($res, 197 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_OData Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_odata_get($res, 198 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_OData Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_odata_get($res, 199 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_OData Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_odata_get($res, 200 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_OData Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_odata_get($res, 201 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_OData Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_odata_get($res, 202 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_OData Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_odata_get($res, 203 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_OData Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_odata_get($res, 204 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_OData Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_odata_get($res, 205 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_OData Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_odata_get($res, 206 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_OData Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworks_odata_get($res, 207 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_OData Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_odata_get($res, 208 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_OData Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_odata_get($res, 209 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_OData Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_odata_get($res, 210 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_OData Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_odata_get($res, 211 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_OData Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_odata_get($res, 212 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_OData Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_odata_get($res, 213 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_OData Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_odata_get($res, 214 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_OData Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_odata_get($res, 215 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_OData Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_odata_get($res, 216 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_OData Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_odata_get($res, 217 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (IPWorks_OData Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_odata_get($res, 218 );
ipworks_odata_set($res, 218, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (IPWorks_OData Class)

This property includes the contents of the last response from the server.

Object Oriented Interface

public function getTransferredData();

Procedural Interface

ipworks_odata_get($res, 219 );

Default Value

''

Remarks

This property is used to get the data of the last response from the server.

TransferredData will be populated after a successful QueryService or CustomRequest call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.

This property is read-only and not available at design time.

Data Type

Binary String

User Property (IPWorks_OData Class)

This property includes a user name if authentication is to be used.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworks_odata_get($res, 220 );
ipworks_odata_set($res, 220, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

Config Method (IPWorks_OData Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_odata_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateEntry Method (IPWorks_OData Class)

This method creates a new entry within the specified OData service resource.

Object Oriented Interface

public function doCreateEntry();

Procedural Interface

ipworks_odata_do_createentry($res);

Remarks

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

Upon a successful creation, all previous entries contained by the component, before the CreateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

CustomRequest Method (IPWorks_OData Class)

This method sends a request to the specified URL using the HTTPMethod and PostData provided.

Object Oriented Interface

public function doCustomRequest($httpmethod, $url, $postdata);

Procedural Interface

ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata);

Remarks

This method sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g., POST) and the data sent are determined by PostData. If a custom request does not require data to be sent, simply set the PostData parameter to an empty string.

Note: All values specified are taken as entered.

OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the TransferredHeaders property as well as through the Header event.

The class will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex also will be set to 1, thus populating EntryProperties.

DeleteEntry Method (IPWorks_OData Class)

This method deletes an entry within an OData service resource.

Object Oriented Interface

public function doDeleteEntry();

Procedural Interface

ipworks_odata_do_deleteentry($res);

Remarks

The component will delete the entry, of an OData service resource, specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

An "If-Match" header will be sent in the delete request with the value contained within EntryETag.

Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. OtherHeaders also will be cleared and thus will need to be reset accordingly with each call made.

GetEntryProperty Method (IPWorks_OData Class)

This method gets an OData entry property.

Object Oriented Interface

public function doGetEntryProperty($xpath);

Procedural Interface

ipworks_odata_do_getentryproperty($res, $xpath);

Remarks

This method is intended to extend the functionality of the OData class and will retrieve the value of the entry property specified by XPath. XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When EntryIndex is set to an index greater than or equal to zero, a relative path also can be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by EntryIndex.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element, and attribute can be any attribute of that field. If an attribute is not supplied, the GetEntryProperty method will return the text portion of property.

Example 1. Attribute Not Supplied: ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Example 2. Relative Path: In the following example, a relative path is used to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.GetEntryProperty("ID") ODataControl.GetEntryProperty("ID@type") ODataControl.GetEntryProperty("Address/State")

GetSchema Method (IPWorks_OData Class)

This method retrieves the schema for a service.

Object Oriented Interface

public function doGetSchema();

Procedural Interface

ipworks_odata_do_getschema($res);

Remarks

This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.

Upon successful retrieval of the schema, set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

Additional details about the schema can be retrieved via XPath.

HasXPath Method (IPWorks_OData Class)

This method determines whether a specific element exists in the document.

Object Oriented Interface

public function doHasXPath($xpath);

Procedural Interface

ipworks_odata_do_hasxpath($res, $xpath);

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

QueryService Method (IPWorks_OData Class)

This method queries an OData service using the specified parameters.

Object Oriented Interface

public function doQueryService();

Procedural Interface

ipworks_odata_do_queryservice($res);

Remarks

This method queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To retrieve an OData feed, without performing any filtering, you can leave Query*** and OtherQueryOptions empty and call QueryService.

The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the ParsedHeaders property as well as through the Header event.

The class will attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath.

Reset Method (IPWorks_OData Class)

This method resets all of properties of the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_odata_do_reset($res);

Remarks

The Reset method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

SetEntryProperty Method (IPWorks_OData Class)

This method is used to set an OData entry property.

Object Oriented Interface

public function doSetEntryProperty($xpath, $value);

Procedural Interface

ipworks_odata_do_setentryproperty($res, $xpath, $value);

Remarks

This method is intended to extend functionality of the OData class and will set the value of the entry property (specified by XPath) to the specified Value. Therefore, the value of the corresponding property will be updated within EntryProperties.

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the class will use the specified EntryIndex along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element.

Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName") Example 2. Retrieve Properties:

The following example uses a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.SetEntryProperty("Name", "MyNewName") ODataControl.SetEntryProperty("Address/State", "NC")

SetSchemaEntity Method (IPWorks_OData Class)

This method sets the schema entity.

Object Oriented Interface

public function doSetSchemaEntity($name);

Procedural Interface

ipworks_odata_do_setschemaentity($res, $name);

Remarks

The class will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys), properties (via SchemaProperty), and navigation properties (via SchemaAssociation) contained within the specified entity.

SetSchemaProperty Method (IPWorks_OData Class)

This method sets the schema property.

Object Oriented Interface

public function doSetSchemaProperty($name);

Procedural Interface

ipworks_odata_do_setschemaproperty($res, $name);

Remarks

The class will set the schema property to the Name specified. Once set, you can view the details of the property (via SchemaProperty) along with the complex type details (via SchemaTypeField); provided that the property is derived from the complex type.

SetSchemaType Method (IPWorks_OData Class)

This method sets the schema type.

Object Oriented Interface

public function doSetSchemaType($name);

Procedural Interface

ipworks_odata_do_setschematype($res, $name);

Remarks

The class will set the schema type to the Name specified. Once set, you can view the details of the complex type (via SchemaTypeField).

UpdateEntry Method (IPWorks_OData Class)

This method updates an OData entry.

Object Oriented Interface

public function doUpdateEntry();

Procedural Interface

ipworks_odata_do_updateentry($res);

Remarks

The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It also will update the OData entry with the elements specified by EntryProperties.

Upon a successful update, all previous entries contained by the component, before the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

UpdateProperty Method (IPWorks_OData Class)

This method updates an OData entry property.

Object Oriented Interface

public function doUpdateProperty($xpath, $value);

Procedural Interface

ipworks_odata_do_updateproperty($res, $xpath, $value);

Remarks

The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It will update only the single entry property specified by XPath with the specified Value.

Upon a successful update, all previous entries contained by the component, before the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Connected Event (IPWorks_OData Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_odata_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (IPWorks_OData Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_odata_register_callback($res, 2, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorks_OData Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_odata_register_callback($res, 3, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Entity Event (IPWorks_OData Class)

This event is fired once for each entity retrieved.

Object Oriented Interface

public function fireEntity($param);

Procedural Interface

ipworks_odata_register_callback($res, 4, array($this, 'fireEntity'));

Parameter List

 'name'

Remarks

The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through GetSchema.

Entry Event (IPWorks_OData Class)

This event is fired once for each entry retrieved.

Object Oriented Interface

public function fireEntry($param);

Procedural Interface

ipworks_odata_register_callback($res, 5, array($this, 'fireEntry'));

Parameter List

 'id'
 'title'
 'summary'
 'etag'

Remarks

The Entry event is fired once for each entry found in the response.

The entry properties are provided through EntryProperties.

The entry links are provided through EntryLinks.

Error Event (IPWorks_OData Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_odata_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (IPWorks_OData Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_odata_register_callback($res, 7, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (IPWorks_OData Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_odata_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Property Event (IPWorks_OData Class)

This event is fired once for each property found within an entity.

Object Oriented Interface

public function fireProperty($param);

Procedural Interface

ipworks_odata_register_callback($res, 9, array($this, 'fireProperty'));

Parameter List

 'name'
 'typename'
 'nullable'

Remarks

The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.

SetCookie Event (IPWorks_OData Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworks_odata_register_callback($res, 10, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (IPWorks_OData Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_odata_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorks_OData Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_odata_register_callback($res, 12, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorks_OData Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_odata_register_callback($res, 13, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (IPWorks_OData Class)

Fired when the HTTP status line is received from the server.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworks_odata_register_callback($res, 14, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (IPWorks_OData Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_odata_register_callback($res, 15, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (OData Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

OData Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (OData Class)

OData Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors