Skip to main content
Get All Document Template Entity

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

includeDeleted
boolean

Response

OK

DocumentTemplateId
integer<int32>

Primary key

Name
string

The template list item

Tooltip
string

Tooltip or other description

SaveInDb
integer<int32>

1 = save document records in DB; otherwise not.

Filename
string

Relative to TemplatePath, or extref for other document plugins. i.e URL or full path.

DefaultOref
string

Processed via tag substitution to give document reference

RecordType
enum<string>

1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes

Available options:
Unknown,
Appointment,
Document,
Email,
Fax,
Phone,
Todo,
MergeDraft,
MergeFinal,
SavedReport
Deleted
boolean

True if deleted

Direction
enum<string>

1 = incoming, 2 = outgoing, see EAppntDirection

Available options:
Unknown,
Incoming,
Outgoing,
SaintAll
AutoeventId
integer<int32>

Which document plugin is responsible for the documents generated from this template

IntentId
integer<int32>

What is the intention of this document (used by SAINT)

IsDefaultPublished
boolean

Published to external persons

Rank
integer<int32>

Rank order

LoadTemplateFromPlugin
integer<int32>

Which document plugin is responsible for this template's contents

MimeType
string

The mime type

IsInUseInGuides
boolean

True if the template is in use in a project or sales guide

DocumentTypeKey
integer<int32>

The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file.

QuoteDocType
enum<string>

The role this document plays in the Quote system, if any

Available options:
None,
MailBody,
MainDocument,
QuoteLines,
ConfirmationMailBody,
ConfirmationLines
PrivacyDocType
enum<string>

Indicator that this document template has a functional role, related to privacy/GDPR

Available options:
None,
PersonRegistered
EmailSubject
string

Subject to use if document template is an email.

IncludeSignature
boolean

True if the email signature should be added in bottom of mail if this an email template

ShowCurrents
boolean

True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc

SenderEmailMode
enum<string>

If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address

Available options:
UseDefaultSender,
UseOurContact,
UseSupportContact,
UseLoggedInUser
SenderEmailAddress
string

If email template, default senderaddress when template is of type quote email or privacy email.

InvitationDocType
enum<string>

Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3

Available options:
None,
New,
Changed,
Cancelled
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.