POST api/v2/documents/templates/create

CreateDocumentTemplate

Request Information

URI Parameters

None.

Body Parameters

The command

CreateDocumentTemplateCommand
NameDescriptionTypeAdditional information
OrganizationId

universally unique identifier

Required

PdfKind

DocumentPdfKind

Required

IntervalKind

DocumentTemplateIntervalKind

Required

Name

string

Required

Max length: 100

Description

string

Required

Max length: 500

GroupName

string

Max length: 100

Order

integer (32 bits)

None.

Request Formats

application/json

Sample:
{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "PdfKind": "ElectricalProjectPriceQuote",
  "IntervalKind": "None",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "GroupName": "sample string 3",
  "Order": 1
}

Response Information

Resource Description

CreateDocumentTemplateCommandResult

CreateDocumentTemplateCommandResult
NameDescriptionTypeAdditional information
Result

CreateDocumentTemplateCommandResultKind

Required

DocumentTemplateId

universally unique identifier

Required

Response Formats

application/json

Sample:
{
  "Result": "Success",
  "DocumentTemplateId": "00000000-0000-0000-0000-000000000000"
}