Versions Compared

Key

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

...

ServiceDescription
SetHALItem

Usage:
HTTP_JSON_Services('SetHALItem', ItemURL, ColumnNames, ColumnValues, DataTypes)

Comments:
Creates a HAL+JSON object for a specific item. Requires the GetHAL service to return the serialized object.

Returns:
N/A

SetHALCollection

Usage:
HTTP_JSON_Services('SetHALCollection', CollectionURL, ItemsURLs, ItemsTitles)

Comments:
Creates a HAL+JSON object for a collection. Requires the GetHAL service to return the serialized object.

Returns:
N/A

SetHALCollectionEmbedded

Usage:
HTTP_JSON_Services('SetHALCollectionEmbedded', CollectionURL, ItemsURLs, ColumnNames, ColumnValues, DataTypes)

Comments:
Creates a HAL+JSON object for a collection of embedded items. Requires the GetHAL service to return the serialized object.

Returns:
N/A

SetHALLinks

Usage:
HTTP_JSON_Services('SetHALLinks', SelfURI, HREFNames, HREFURIs, ChildNames, hChildren, Names, Values)

Comments:
Creates a HAL style "links" object.

Returns:
N/A

GetHAL

Usage:
HTTP_JSON_Services('GetHAL', ItemArrayLabel)

Comments:
Returns the serialized JSON object for the current HAL response. If no HAL object has been defined then this will return an empty string and a 500 status code will be set. All HAL objects and arrays will be released in this service.

Returns:
A serialized HAL+JSON object based based on the current HAL objects in memory.

GetSchemaRootObj

Usage:
HTTP_JSON_Services('GetSchemaRootObj')

Comments:
Returns the handle to a root Schema object. If it does not already exist it will be created with the standard "$schema" value already added.

Returns:
Handle to a root Schema+JSON object.

SetSchemaMeta

Usage:
HTTP_JSON_Services('SetSchemaMeta', Title, Description, Type)

Comments:
Sets the meta data associated to the schema object.

Returns:
N/A

SetSchemaProperty

Usage:
HTTP_JSON_Services('SetSchemaProperty', Name, Title, Type, Format, EnumList, Required)

Comments:
Sets a property to the schema. There can be more than one property so this service will add another property to the list if it already exists.

Returns:
N/A

GetSchema

Usage:
HTTP_JSON_Services('GetSchema')

Comments:
Returns the serialized JSON object for the current schema. If no schema object has been defined then this will return an empty string and a 500 status code will be set. All schema objects and arrays will be released in this service.

Returns:
A serialized Schema+JSON object based based on the current Schema objects in memory.

GetURLFromID

Usage:
HTTP_JSON_Services('GetURLFromID', ID)

Comments:
Returns a URL segment for the ID passed into the service. This creates a "slug" style URL so that it will be search friendly, human readable, and an RESTful.

Returns:
A "slug" style URL segment for a given resource ID.

GetIDFromURL

Usage:
HTTP_JSON_Services('GetIDFromURL', URL, Array)

Comments:
Returns the ID based on the URL passed into the service. This service attempts to reverse engineer the URL.

Returns:
A resource (item) ID.

...

Params

The proper use of the generic arguments are defined in the definition of each service above.