Create Default Template Variables Parameters

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/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 => "53294",
  CURLOPT_URL => "http://localhost:53294/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",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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:53294/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/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

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/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 => "53294",
  CURLOPT_URL => "http://localhost:53294/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",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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:53294/api/v1/Agents/Document/CreateDefaultTemplateVariablesParameters"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/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": {}
}

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.

Response

Parameters specifying source and properties for template variable substitution. Carrier object for TemplateVariablesParameters. Services for the TemplateVariablesParameters Carrier is available from the Document Agent.

SourceInput

string

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

enum<string>

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

CultureName

string

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.

ContactId

integer<int32>

Identifier for a contact

PersonId

integer<int32>

Identifier for a person

ProjectId

integer<int32>

Identifier for a project

SelectionId

integer<int32>

Identifier for a selection

AppointmentId

integer<int32>

Identifier for an appointment

DocumentId

integer<int32>

Identifier for a document

SaleId

integer<int32>

Identifier for a sale

QuoteLineId

integer<int32>

Quote line id

QuoteAlternativeId

integer<int32>

Quote alternative id

ProductKey

string

Product key

CustomTags

string[][]

Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width.

TicketId

integer<int32>

Identifier for ticket

DocumentEntity

object

Partial DocumentEntity class associating the generated DocumentEntity with an interface.

Show child attributes

TableRight

object

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

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes