Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.87 KB

index.md

File metadata and controls

63 lines (42 loc) · 2.87 KB

BaseRestExtension.config

BaseRestExtension.config contains the data necessary for the /Base system when exposing the methods in your class library.

<?xml version="1.0" encoding="utf-8"?>
<BaseRestExtensions>
  
  <extension alias="aliasName" type="the.fully.qualified.name, assemblyName">
    <method name="Hello" returnXml="false" allowAll="true"></method>
  </extension>
  
</BaseRestExtensions>

It contains one extension tag for each class you want the /Base system to expose, and the method tags for each method you want the /Base system to expose.

The extension tag contains the following attributes:

  • type: The fully qualified name of the class containing the methods you want to expose via /Base
  • alias: The name that /Base will use when mapping urls to your class. If you put "MyAlias" here, the url will start with: yourdomainname/Base/MyAlias.

The method tag contains the following attributes:

  • name: The name of the method in your class, this has to correspond exactly with the name in the code. It is not possible to make aliases for the methods.
  • allowAll: If this attribute is set to "true", there will be no restrictions on who will be able to call this method.
  • allowGroup: This attribute can contain a comma separated string of user group names that will be allowed to call this method.
  • allowType: This attribute can contain a comma separated string of user type names that will be allowed to call this method.
  • allowMember: This attribute can contain the id of a single user allowed to call this method.
  • returnXml: if set to false, Umbraco will not wrap the result of the method in a element.

The user calling the method, will be allowed if she has access through at least one of the possible attribute values. If allowAll is set to true, the other attributes has no effect, everyone will be allowed.

Example

BaseRestExtensions.config

<?xml version="1.0" encoding="utf-8"?>
<BaseRestExtensions>
  
  <extension alias="test" type="BasetTest.TestClass,basetest">
    <method name="Hello" returnXml="false" allowAll="true"></method>
  </extension>
  
</BaseRestExtensions>

BaseTest.cs

namespace BaseTest {
    public class TestClass {
        public static string Hello() {
            return "Hello World";
        }
    }
}

Visit the /base url. For example: http://example.com/base/test/Hello/.

Hello World

Also check out the examples included with Umbraco:

The config is clean and simple. If you are familiar with C# and interested in taking a peek behind the scenes check out https://github.com/umbraco/Umbraco-CMS/tree/6.2.0/src/Umbraco.Web/BaseRest/Configuration