Difference between revisions of "UBIK Web Service"

Revision as of 08:00, 2 August 2019

Web Service Documentation

Fetch MetaDefinitions

Provides the configured ACM (see Application Context Management) Datemodell to the client.

/// <summary>
/// Delivers a list of all defined MetaClass Objects for the given Application and the given DeviceID
/// </summary>
/// <param name="appName">Name of the Application</param>
/// <param name="contextName">Name of the Context</param>
/// <param name="authentication">authentication (tokenid) for the user/device to access this service</param>
/// <returns>a list of MetaDefinitions</returns>
[OperationContract]
[WebInvoke(UriTemplate = "GetMetaDefinitionsV212/{appName}/{contextName}/{authentication}/{version}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
BCMetaDefinitions GetMetaDefinitionsV212(String appName, String contextName, string authentication, string version);

List ofParameters

Name	Type	Description
appName	String	Name of the Application
contextName	String	Name of the Context
authentication	String	Valid auth token
version	String	Indicator of the expected data format version

Code Example (c#)

string appName = "APP_TEST";
string ctxName = "CTX_TEST";
string authToken = FetchValidAuthToken();
string v212 = "212";

BCMetaDefinitions metaDefintions = target.GetMetaDefinitionsV212(appName, ctxName, authToken, v212);

@@ Line 1: / Line 1: @@
+Web Service Documentation
+== Fetch MetaDefinitions ==
+Provides the configured ACM (see [[Application_Context_Management]]) Datemodell to the client.
+<source lang="csharp">
+        /// <summary>
+        /// Delivers a list of all defined MetaClass Objects for the given Application and the given DeviceID
+        /// </summary>
+        /// <param name="appName">Name of the Application</param>
+        /// <param name="contextName">Name of the Context</param>
+        /// <param name="authentication">authentication (tokenid) for the user/device to access this service</param>
+        /// <returns>a list of MetaDefinitions</returns>
+        [OperationContract]
+        [WebInvoke(UriTemplate = "GetMetaDefinitionsV212/{appName}/{contextName}/{authentication}/{version}", Method = "GET",
+                   RequestFormat = WebMessageFormat.Json,
+                   ResponseFormat = WebMessageFormat.Json)]
+        BCMetaDefinitions GetMetaDefinitionsV212(String appName, String contextName, string authentication, string version);
+</source>
+=== List ofParameters ===
+{| class="wikitable" | width = "50%"
+|-
+! Name!! Type !! Description
+|-
+| appName|| String || Name of the Application
+|-
+| contextName|| String || Name of the Context
+|-
+| authentication|| String || Valid auth token
+|-
+| version|| String || Indicator of the expected data format version
+|-
+|}
+=== Code Example (c#) ===
+	<source lang="csharp">
+	string appName = "APP_TEST";
+	string ctxName = "CTX_TEST";
+	string authToken = FetchValidAuthToken();
+	string v212 = "212";
+	BCMetaDefinitions metaDefintions = target.GetMetaDefinitionsV212(appName, ctxName, authToken, v212);
+</source>
 [[Category:Server|Web Service]]