GET api/document-creator/template?doctype={doctype}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
docType

string

Required

Body Parameters

None.

Response Information

Resource Description

DocumentTemplateDto
NameDescriptionTypeAdditional information
DocType

string

None.

RequestTypeId

integer

None.

ItemTypeId

integer

None.

Slots

Collection of DocumentSlotDto

None.

ItemSources

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "DocType": "sample string 1",
  "RequestTypeId": 2,
  "ItemTypeId": 3,
  "Slots": [
    {
      "Key": "sample string 1",
      "Label": "sample string 2",
      "Order": 3,
      "Kind": "sample string 4",
      "RequiredBy": "sample string 5",
      "AltKey": "sample string 6"
    },
    {
      "Key": "sample string 1",
      "Label": "sample string 2",
      "Order": 3,
      "Kind": "sample string 4",
      "RequiredBy": "sample string 5",
      "AltKey": "sample string 6"
    }
  ],
  "ItemSources": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<DocumentTemplateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FraxionSM.API.Controllers">
  <DocType>sample string 1</DocType>
  <ItemSources xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ItemSources>
  <ItemTypeId>3</ItemTypeId>
  <RequestTypeId>2</RequestTypeId>
  <Slots>
    <DocumentSlotDto>
      <AltKey>sample string 6</AltKey>
      <Key>sample string 1</Key>
      <Kind>sample string 4</Kind>
      <Label>sample string 2</Label>
      <Order>3</Order>
      <RequiredBy>sample string 5</RequiredBy>
    </DocumentSlotDto>
    <DocumentSlotDto>
      <AltKey>sample string 6</AltKey>
      <Key>sample string 1</Key>
      <Kind>sample string 4</Kind>
      <Label>sample string 2</Label>
      <Order>3</Order>
      <RequiredBy>sample string 5</RequiredBy>
    </DocumentSlotDto>
  </Slots>
</DocumentTemplateDto>