GET api/documents/master/{id}

ListURL parameter value: API for the upload component. Only a single item is returned, since there can be only one template document per level for a company.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Valid document template ID. If it refers to a non-global template, it has to belong to the user's accounting office or company.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of DocumentMasterDTO
NameDescriptionTypeAdditional information
ID

Id uniquely identifying the template.

globally unique identifier

None.

Description

[ Description for the document template, indicating whether the template is user-specified or inherited.

string

None.

BlobLink

Download link for the document template.

string

None.

BlobName

Template path.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "5706cc52-c1f8-45a2-93f7-80e471c763b3",
    "Description": "sample string 2",
    "BlobLink": "sample string 3",
    "BlobName": "sample string 4"
  },
  {
    "ID": "5706cc52-c1f8-45a2-93f7-80e471c763b3",
    "Description": "sample string 2",
    "BlobLink": "sample string 3",
    "BlobName": "sample string 4"
  }
]

text/html

Sample:
[{"ID":"5706cc52-c1f8-45a2-93f7-80e471c763b3","Description":"sample string 2","BlobLink":"sample string 3","BlobName":"sample string 4"},{"ID":"5706cc52-c1f8-45a2-93f7-80e471c763b3","Description":"sample string 2","BlobLink":"sample string 3","BlobName":"sample string 4"}]

application/xml, text/xml

Sample:
<ArrayOfDocumentMasterDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DocumentMasterDTO>
    <BlobLink>sample string 3</BlobLink>
    <BlobName>sample string 4</BlobName>
    <Description>sample string 2</Description>
    <ID>5706cc52-c1f8-45a2-93f7-80e471c763b3</ID>
  </DocumentMasterDTO>
  <DocumentMasterDTO>
    <BlobLink>sample string 3</BlobLink>
    <BlobName>sample string 4</BlobName>
    <Description>sample string 2</Description>
    <ID>5706cc52-c1f8-45a2-93f7-80e471c763b3</ID>
  </DocumentMasterDTO>
</ArrayOfDocumentMasterDTO>