Create Default Template Variables Parameters
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {method: 'POST'};
fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"SourceInput": "<string>",
"Encoding": "Text",
"CultureName": "<string>",
"ContactId": 123,
"PersonId": 123,
"ProjectId": 123,
"SelectionId": 123,
"AppointmentId": 123,
"DocumentId": 123,
"SaleId": 123,
"QuoteLineId": 123,
"QuoteAlternativeId": 123,
"ProductKey": "<string>",
"CustomTags": [
[
"<string>"
]
],
"TicketId": 123,
"DocumentEntity": {
"DocumentId": 123,
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Attention": "<string>",
"Header": "<string>",
"Name": "<string>",
"OurRef": "<string>",
"YourRef": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"Description": "<string>",
"DocumentTemplate": {
"DocumentTemplateId": 123,
"Name": "<string>",
"Tooltip": "<string>",
"SaveInDb": 123,
"Filename": "<string>",
"DefaultOref": "<string>",
"RecordType": "Unknown",
"Deleted": 123,
"Direction": "Unknown",
"AutoeventId": 123,
"QuoteDocType": "None",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Person": {
"Position": "<string>",
"PersonId": 123,
"Mrmrs": "<string>",
"Firstname": "<string>",
"Lastname": "<string>",
"MiddleName": "<string>",
"Title": "<string>",
"Description": "<string>",
"Email": "<string>",
"FullName": "<string>",
"DirectPhone": "<string>",
"FormalName": "<string>",
"CountryId": 123,
"ContactId": 123,
"ContactName": "<string>",
"Retired": 123,
"Rank": 123,
"ActiveInterests": 123,
"ContactDepartment": "<string>",
"ContactCountryId": 123,
"ContactOrgNr": "<string>",
"FaxPhone": "<string>",
"MobilePhone": "<string>",
"ContactPhone": "<string>",
"AssociateName": "<string>",
"AssociateId": 123,
"UsePersonAddress": true,
"ContactFax": "<string>",
"Kanafname": "<string>",
"Kanalname": "<string>",
"Post1": "<string>",
"Post2": "<string>",
"Post3": "<string>",
"EmailName": "<string>",
"ContactFullName": "<string>",
"ActiveErpLinks": 123,
"TicketPriorityId": 123,
"SupportLanguageId": 123,
"SupportAssociateId": 123,
"CategoryName": "<string>",
"PersonNumber": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Associate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Contact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Project": {
"ProjectId": 123,
"Name": "<string>",
"Description": "<string>",
"URL": "<string>",
"Type": "<string>",
"AssociateId": 123,
"AssociateFullName": "<string>",
"TypeId": 123,
"Updated": "2023-11-07T05:31:56Z",
"StatusId": 123,
"Status": "<string>",
"TextId": 123,
"PublishTo": "2023-11-07T05:31:56Z",
"PublishFrom": "2023-11-07T05:31:56Z",
"IsPublished": true,
"URLName": "<string>",
"ProjectNumber": "<string>",
"ActiveErpLinks": 123,
"EventId": 123,
"StartDate": "2023-11-07T05:31:56Z",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Date": "2023-11-07T05:31:56Z",
"ExternalRef": "<string>",
"Completed": "Unknown",
"ActiveLinks": 123,
"Type": "Unknown",
"Links": [
{
"EntityName": "<string>",
"Id": 123,
"Description": "<string>",
"ExtraInfo": "<string>",
"LinkId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"LockSemantics": "None",
"Sale": {
"ContactName": "<string>",
"SaleDate": "2023-11-07T05:31:56Z",
"SaleId": 123,
"Probability": 123,
"Title": "<string>",
"Amount": 123,
"Currency": "<string>",
"ProjectName": "<string>",
"AssociateFullName": "<string>",
"Description": "<string>",
"Status": "Unknown",
"WeightedAmount": 123,
"ProjectId": 123,
"EarningPercent": 123,
"Earning": 123,
"ContactId": 123,
"AssociateId": 123,
"PersonId": 123,
"SaleTypeId": 123,
"SaleTypeName": "<string>",
"PersonFullName": "<string>",
"Completed": "Unknown",
"ActiveErpLinks": 123,
"NextDueDate": "2023-11-07T05:31:56Z",
"Number": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"SuggestedDocumentId": 123,
"Snum": 123,
"UserDefinedFields": {},
"ExtraFields": {},
"CustomFields": {},
"PublishEventDate": "2023-11-07T05:31:56Z",
"PublishTo": "2023-11-07T05:31:56Z",
"PublishFrom": "2023-11-07T05:31:56Z",
"IsPublished": true,
"VisibleFor": [
{
"VisibleId": 123,
"Visibility": "All",
"DisplayValue": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Create Default Template Variables Parameters
Loading default values into a new TemplateVariablesParameters.
NsApiSlow threshold: 5000 ms.
Create Default Template Variables Parameters
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {method: 'POST'};
fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"SourceInput": "<string>",
"Encoding": "Text",
"CultureName": "<string>",
"ContactId": 123,
"PersonId": 123,
"ProjectId": 123,
"SelectionId": 123,
"AppointmentId": 123,
"DocumentId": 123,
"SaleId": 123,
"QuoteLineId": 123,
"QuoteAlternativeId": 123,
"ProductKey": "<string>",
"CustomTags": [
[
"<string>"
]
],
"TicketId": 123,
"DocumentEntity": {
"DocumentId": 123,
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Attention": "<string>",
"Header": "<string>",
"Name": "<string>",
"OurRef": "<string>",
"YourRef": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"Description": "<string>",
"DocumentTemplate": {
"DocumentTemplateId": 123,
"Name": "<string>",
"Tooltip": "<string>",
"SaveInDb": 123,
"Filename": "<string>",
"DefaultOref": "<string>",
"RecordType": "Unknown",
"Deleted": 123,
"Direction": "Unknown",
"AutoeventId": 123,
"QuoteDocType": "None",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Person": {
"Position": "<string>",
"PersonId": 123,
"Mrmrs": "<string>",
"Firstname": "<string>",
"Lastname": "<string>",
"MiddleName": "<string>",
"Title": "<string>",
"Description": "<string>",
"Email": "<string>",
"FullName": "<string>",
"DirectPhone": "<string>",
"FormalName": "<string>",
"CountryId": 123,
"ContactId": 123,
"ContactName": "<string>",
"Retired": 123,
"Rank": 123,
"ActiveInterests": 123,
"ContactDepartment": "<string>",
"ContactCountryId": 123,
"ContactOrgNr": "<string>",
"FaxPhone": "<string>",
"MobilePhone": "<string>",
"ContactPhone": "<string>",
"AssociateName": "<string>",
"AssociateId": 123,
"UsePersonAddress": true,
"ContactFax": "<string>",
"Kanafname": "<string>",
"Kanalname": "<string>",
"Post1": "<string>",
"Post2": "<string>",
"Post3": "<string>",
"EmailName": "<string>",
"ContactFullName": "<string>",
"ActiveErpLinks": 123,
"TicketPriorityId": 123,
"SupportLanguageId": 123,
"SupportAssociateId": 123,
"CategoryName": "<string>",
"PersonNumber": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Associate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Contact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Project": {
"ProjectId": 123,
"Name": "<string>",
"Description": "<string>",
"URL": "<string>",
"Type": "<string>",
"AssociateId": 123,
"AssociateFullName": "<string>",
"TypeId": 123,
"Updated": "2023-11-07T05:31:56Z",
"StatusId": 123,
"Status": "<string>",
"TextId": 123,
"PublishTo": "2023-11-07T05:31:56Z",
"PublishFrom": "2023-11-07T05:31:56Z",
"IsPublished": true,
"URLName": "<string>",
"ProjectNumber": "<string>",
"ActiveErpLinks": 123,
"EventId": 123,
"StartDate": "2023-11-07T05:31:56Z",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Date": "2023-11-07T05:31:56Z",
"ExternalRef": "<string>",
"Completed": "Unknown",
"ActiveLinks": 123,
"Type": "Unknown",
"Links": [
{
"EntityName": "<string>",
"Id": 123,
"Description": "<string>",
"ExtraInfo": "<string>",
"LinkId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"LockSemantics": "None",
"Sale": {
"ContactName": "<string>",
"SaleDate": "2023-11-07T05:31:56Z",
"SaleId": 123,
"Probability": 123,
"Title": "<string>",
"Amount": 123,
"Currency": "<string>",
"ProjectName": "<string>",
"AssociateFullName": "<string>",
"Description": "<string>",
"Status": "Unknown",
"WeightedAmount": 123,
"ProjectId": 123,
"EarningPercent": 123,
"Earning": 123,
"ContactId": 123,
"AssociateId": 123,
"PersonId": 123,
"SaleTypeId": 123,
"SaleTypeName": "<string>",
"PersonFullName": "<string>",
"Completed": "Unknown",
"ActiveErpLinks": 123,
"NextDueDate": "2023-11-07T05:31:56Z",
"Number": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"SuggestedDocumentId": 123,
"Snum": 123,
"UserDefinedFields": {},
"ExtraFields": {},
"CustomFields": {},
"PublishEventDate": "2023-11-07T05:31:56Z",
"PublishTo": "2023-11-07T05:31:56Z",
"PublishFrom": "2023-11-07T05:31:56Z",
"IsPublished": true,
"VisibleFor": [
{
"VisibleId": 123,
"Visibility": "All",
"DisplayValue": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Response
OK
Parameters specifying source and properties for template variable substitution. Carrier object for TemplateVariablesParameters. Services for the TemplateVariablesParameters Carrier is available from the Document Agent.
Source string to parse for template variables. Such variables must have delimiters corresponding to the standard for the given generator encoding.Non-text source data (such as the binary content of a .doc file) should be passed in as Base64.
Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.
Available options:
Text, Html, Xml, MsWord, MsExcel, MsPowerpoint, MsOffice2007, MsOffice2007Xml, Url, UrlUnicode, Pdf, Mime, OpenDocument, OpenDocumentXml, MsWord2007 Name of culture to be used for culture-sensitive data, such as dates or multi-language texts. Use a blank string to accept current culture that is set on the server.
Identifier for a contact
Identifier for a person
Identifier for a project
Identifier for a selection
Identifier for an appointment
Identifier for a document
Identifier for a sale
Quote line id
Quote alternative id
Product key
Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width.
Identifier for ticket
Partial DocumentEntity class associating the generated DocumentEntity with an interface.
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Related topics
NSDocumentAgentNSTemplateVariablesParametersCreate Default Document Template LanguageCreate Default Document Template Migration ListCreate Default Document Template Entity⌘I