Jump to: navigation, search

Changes


UBIK Web Service

3,919 bytes added, 08:35, 2 August 2019
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
BCMetaDefinitions GetMetaDefinitionsV212( String appName, String contextName, string String authentication, string String version);
</source>
string ctxName = "CTX_TEST";
string authToken = FetchValidAuthToken();
string v212 version = "212263";
UBIKContentClient target = new UBIKContentClient(WEBSERVER_NAME); BCMetaDefinitions metaDefintions = target.GetMetaDefinitionsV212( appName, ctxName, authToken, version);</source> == Download Content == GetHierarchyDeltasV212 is used for downloading single objects as well as branches, root objects and the infrastructure. <source lang="csharp"> /// <summary> /// The main method for downloading content. /// This method is used for downloading single objects as well as branches, root objects and the infrastructure /// </summary> /// <param name="appName">Name of the application.</param> /// <param name="contextName">Name of the context.</param> /// <param name="args">The arguments.</param> /// <param name="authentication">authentication (tokenid) for the user/device to access this service</param> /// <param name="version">The versionindicator.</param> /// <returns>a set of content objects</returns> [OperationContract] [WebInvoke(UriTemplate = "GetMetaDefinitionsV212/{appName}/{contextName}/{authentication}/{version}", Method = "GET", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)] BCHierarchyDeltaShipments GetHierarchyDeltasV212( String appName, String contextName, HierarchyDeltaArguments args, 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|- | args || HierarchyDeltaArguments || Defines the type of download (root, infra, branch) as well as the startobject and the download depth|- | authentication|| String || Valid auth token|- | version|| String || Indicator of the expected data format version|- |}  === Code Example (c#) ===Downloading Root Objects <source lang="csharp"> string appName = "APP_TEST"; string ctxName = "CTX_TEST"; string authToken = FetchValidAuthToken(); string version = "263";  HierarchyDeltaArguments args = new HierarchyDeltaArguments() { ChildrenDepth = 1, ParentDepth = 0, StartingPoint = new HierarchyRoot(), }; UBIKContentClient target = new UBIKContentClient(WEBSERVER_NAME); BCHierarchyDeltaShipments roots = target.GetHierarchyDeltasV212( appName, ctxName, args, authToken, version);</source>   Downloading Infrastructure Objects <source lang="csharp"> string appName = "APP_TEST"; string ctxName = "CTX_TEST"; string authToken = FetchValidAuthToken(); string version = "263";  HierarchyDeltaArguments args = new HierarchyDeltaArguments() { ChildrenDepth = 1, ParentDepth = 0, StartingPoint = new HierarchyInfrastructure(), }; UBIKContentClient target = new UBIKContentClient(WEBSERVER_NAME); BCHierarchyDeltaShipments roots = target.GetHierarchyDeltasV212( appName, ctxName, args, authToken, version);</source>   Downloading an entire branch starting at object with UID = '9E8FC21E-137E-4DDB-9D85-6E71B01F12FA' <source lang="csharp"> string appName = "APP_TEST"; string ctxName = "CTX_TEST"; string authToken = FetchValidAuthToken(); string version = "263";  HierarchyDeltaArguments args = new HierarchyDeltaArguments() { ChildrenDepth = 1, ParentDepth = 0, StartingPoint = new HierarchyStartingPoint(new Guid("9E8FC21E-137E-4DDB-9D85-6E71B01F12FA")) }; UBIKContentClient target = new UBIKContentClient(WEBSERVER_NAME); BCHierarchyDeltaShipments roots = target.GetHierarchyDeltasV212( appName, ctxName, args, authToken, v212 version);
</source>
[[Category:Server|Web Service]]
1,579
edits