DocumentTypes

POST 1.0/{InstanceId}/DocumentTypes

Creates a new Document Type

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required

Body Parameters

Contains details of the document type to be created

CreateUpdateDocumentTypeRequest

API Parameter Details
Name	Description	Type	Additional information
Name	The name for the this document type	string	None.
Description	The description for the this document type	string	None.
Active	A booleaan active flag for the this document type	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Active": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateUpdateDocumentTypeRequest'.

Response Information

Resource Description

Returns "Created" and the id / uri if the document type was created successfully, otherwise an appropriate error message

CreatedResourceResponse

API Parameter Details
Name	Description	Type	Additional information
Id	The id of the newly created resource	integer	None.
Uri	The Uri location of the newly created resource	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Uri": "sample string 2"
}