IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

OData Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_OData

Procedural Interface

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

Remarks

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


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

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


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

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


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

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


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

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


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

Property List


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

AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ChannelAuthorEmailThis property contains the email address of the author.
ChannelAuthorNameThis property contains the name of the author.
ChannelAuthorUriThis property contains the URI of the author.
ChannelCategoryLabelThis property contains a textual description of the label for the category.
ChannelCategorySchemeThis property identifies a categorization scheme.
ChannelCategoryTermThis property contains the category to which the entry or feed belongs.
ChannelContributorEmailThis property contains the email address of the contributor.
ChannelContributorNameThis property contains the name of the contributor.
ChannelContributorUriThis property contains the URI of the contributor.
ChannelGeneratorThis property identifies the generator of the feed.
ChannelIconThis property contains a reference to the image that represents this feed.
ChannelIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
ChannelLinkHrefThis property contains the location of the link.
ChannelLinkHrefLangThis property contains the language of the content at the link.
ChannelLinkLengthThis property contains the length (in bytes) of the content at the link.
ChannelLinkRelThis property indicates the relation of the linked content to the feed.
ChannelLinkTitleThis property contains the title of the link.
ChannelLinkTypeThis property contains the MIME type of the content at the link.
ChannelLogoThis property contains logo for an image that represents the feed.
ChannelRightsThis property contains information about the rights of the given feed.
ChannelRightsTextTypeText type of the rights of the feed.
ChannelSubtitleThis contains a short description of the Atom Feed.
ChannelSubtitleTextTypeThis property contains the text type of the sub-title of the feed.
ChannelTitleThis property contains the title of the current Atom Feed.
ChannelTitleTextTypeThis property contains the text type of the title of the feed.
ChannelUpdatedThis property contains the date and time that the feed was updated.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThe domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThe name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
EntryAuthorThe Author of the current entry in an OData feed.
EntryCountThe number of entries contained within an OData feed.
EntryETagThe ETag of the current entry in an OData feed.
EntryIdThe ID of the current entry in an OData feed.
EntryIndexThe index of the current entry in an OData feed.
EntryLinksCountThe number of records in the EntryLinks arrays.
EntryLinksResourcePathThe Resource Path of the OData entry element link.
EntryLinksTitleThe Title of the OData entry element link.
EntryPropertiesCountThe number of records in the EntryProperties arrays.
EntryPropertiesAttributesA space-separated list of attributes (name-value pairs) contained within an OData entry element.
EntryPropertiesIsNullIndicates whether a property value of a primitive type is null.
EntryPropertiesNameThe Name of the OData entry element.
EntryPropertiesTypeThe type of the OData schema property.
EntryPropertiesValueThe Value of the OData entry element.
EntryPropertiesXPathThe XPath of the OData entry property.
EntrySummaryThe Summary of the current entry in an OData feed.
EntryTitleThe Title of the current entry in an OData feed.
EntryUpdatedThe Date-Time when current entry in an OData feed was updated.
EntryXMLThe raw XML of the current entry in an OData feed.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeadersOther headers as determined by the user (optional).
OtherQueryOptionsAdditional Query Options to be used when querying a service.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA password if authentication is to be used.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueryFilterSelects only the entries that satisfy the specified filter (expression).
QueryOrderByThe value used to order entries when querying a service.
QuerySelectSelects only the specified properties to be returned in an entry when querying a service.
QuerySkipThe number of entries to skip when querying a service.
QuerySkipTokenToken given by an OData server when the last query result collection is too large.
QueryTopSelects the first N entries when querying a service.
ResourcePathThe Resource Path of an OData service.
SchemaAssociationDescriptionThe documentation long description of the OData schema association.
SchemaAssociationFromRoleThe name of the starting point of the navigation.
SchemaAssociationFromRoleDescriptionThe documentation long description of the OData schema FromRole association end point.
SchemaAssociationFromRoleEntityThe name of the entity that FromRole association end point maps to.
SchemaAssociationFromRoleMultiplicityThe multiplicity of the FromRole association end point.
SchemaAssociationFromRoleSummaryThe documentation summary of the OData schema FromRole association end point.
SchemaAssociationNameThe Name of the OData schema navigation property.
SchemaAssociationOnDeleteThe delete action to be performed.
SchemaAssociationRelationshipThe name of the relationship (association) of the navigation property.
SchemaAssociationSummaryThe documentation summary of the OData schema association.
SchemaAssociationToRoleThe name of the end point of the navigation.
SchemaAssociationToRoleDescriptionThe documentation long description of the OData schema ToRole association end point.
SchemaAssociationToRoleEntityThe name of the entity that ToRole association end point maps to.
SchemaAssociationToRoleMultiplicityThe multiplicity of the ToRole association end point.
SchemaAssociationToRoleSummaryThe documentation summary of the OData schema ToRole association end point.
SchemaAssociationCountThe number of navigation properties contained within an OData schema entity.
SchemaAssociationIndexThe index of the current navigation property in an OData schema entity.
SchemaEntityDescriptionThe documentation long description of the OData schema entity.
SchemaEntityNameThe name of the OData schema entity.
SchemaEntitySummaryThe documentation summary of the OData schema entity.
SchemaEntityCountThe number of entities contained within an OData schema.
SchemaEntityIndexThe index of the current entity in an OData schema.
SchemaKeysCountThe number of records in the SchemaKeys array.
SchemaKeysThe keys of a schema entity.
SchemaPropertyAttributesA space-separated list of attributes (name-value pairs) contained within an OData property element.
SchemaPropertyDescriptionThe documentation long description of the OData schema property.
SchemaPropertyIsComplexTypeIndicates whether a property is derived from a complex type.
SchemaPropertyNameThe Name of the OData schema property.
SchemaPropertyNullableIndicates whether a property can be null.
SchemaPropertySummaryThe documentation summary of the OData schema property.
SchemaPropertyTypeThe type of the OData schema property.
SchemaPropertyCountThe number of properties contained within an OData schema entity.
SchemaPropertyIndexThe index of the current property in an OData schema entity.
SchemaTypeFieldAttributesA space-separated list of attributes (name-value pairs) contained within an OData property element.
SchemaTypeFieldDescriptionThe documentation long description of the OData schema property.
SchemaTypeFieldIsComplexTypeIndicates whether a property is derived from a complex type.
SchemaTypeFieldNameThe Name of the OData schema property.
SchemaTypeFieldNullableIndicates whether a property can be null.
SchemaTypeFieldSummaryThe documentation summary of the OData schema property.
SchemaTypeFieldTypeThe type of the OData schema property.
SchemaTypeFieldCountThe number of properties contained within an OData schema complex type.
SchemaTypeFieldIndexThe index of the current field (property) in an OData schema complex type.
ServiceRootURIThe root URI of an OData service.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
UserA user name if authentication is to be used.
AttrCountThe number of records in the Attr arrays.
AttrNameThe Name provides the local name (without prefix) of the attribute.
AttrNamespaceAttribute namespace.
AttrPrefixAttribute prefix (if any).
AttrValueAttribute value.
XChildrenCountThe number of records in the XChild arrays.
XChildNameThe Name property provides the local name (without prefix) of the element.
XChildNamespaceNamespace of the element.
XChildPrefixPrefix of the element (if any).
XChildXTextThe inner text of the element.
XElementThe name of the current element.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the document.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.

Method List


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

ConfigSets or retrieves a configuration setting .
CreateEntryCreates a new entry within the specified OData service resource.
CustomRequestSends a request to the specified URL using the HTTP Method and Post Data provided.
DeleteEntryDeletes an entry within an OData service resource.
GetEntryPropertyGet an OData entry property.
GetSchemaRetrieves the schema for a service.
HasXPathDetermines whether a specific element exists in the document.
QueryServiceQueries an OData service using the specified parameters.
ResetReset all properties of the component.
SetEntryPropertySet an OData entry property.
SetSchemaEntitySets the schema entity.
SetSchemaPropertySets the schema property.
SetSchemaTypeSets the schema type.
UpdateEntryUpdate an OData entry.
UpdatePropertyUpdate an OData entry property.

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.

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
EntityFired once for each entity retrieved.
EntryFired once for each entry retrieved.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
PropertyFired once for each property found within an entity.
SetCookieFired for every cookie set by the server.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

EncodeResourcePathWhether the ResourcePath is URL encoded.
NameAndEmailFormatDetermines how the data of the name and e-mail properties will be formatted.
TransferredHeadersThe full set of headers as received from the server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0