DocumentsController Class

[This is preliminary documentation and is subject to change.]

Primary controller responsible for the manipulation of document instances.

Inheritance Hierarchy

SystemObject
  ApiController
    AbstractBiomeController
      WebServiceKit.ControllersDocumentsController

Namespace: WebServiceKit.Controllers
Assembly: WebServiceKit (in WebServiceKit.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class DocumentsController : AbstractBiomeController

Public Class DocumentsController
	Inherits AbstractBiomeController

public ref class DocumentsController : public AbstractBiomeController

type DocumentsController =  
    class
        inherit AbstractBiomeController
    end

The DocumentsController type exposes the following members.

Constructors

	Name	Description
	DocumentsController	Initializes a new instance of the DocumentsController class

Methods

	Name	Description
	Deactivate	Deactivates a document instance by guid in the database.
	Get	Retrieves a document instance by guid from the database.
	GetByType	Retrieves all docuements of a given type in a paged format.
	Insert	Adds a new document instance to the database. All required fields in the document should be filled out. Don't forget the document type guid.
	Update	Updates an existing document instance to the database. All required fields in the document should be filled out. Don't forget the document instance guid.

Remarks

Route: api/dcouments/*