Template Data

The Template Endpoints offer API Methods for Texts, Forms, Polls, and Votings. These Objects are only partly considered as “Media”, their API Access therefore differ. Especially, there are no listing Methods, it is only possible to request the Data of a single Element, mostly referenced by a Reference Context.

As there are no List Methods, all Methods here are Single Item Calls. Therefore, the Result Set Object will be an Object (or NULL, if no valid Item could be found).

Most of the Media API Parameters are supported, if they make Sense for this kind of Objects. Especially important is the "forceLanguage" Parameter, as for most Domains, Forms and Polls are available in multiple Languages.

Text Templates

/textbyreference

GET https://api.nexx.cloud/v3.1/templates/textbyreference/:reference

Path Parameters

Name	Type	Description
reference	string	the Reference Code of any Text Template

200

Form Templates

/formbyid

GET https://api.nexx.cloud/v3.1/templates/formbyid/:formid

Path Parameters

Name	Type	Description
formid	string	the ID of the target Form

200

/formbyreference

GET https://api.nexx.cloud/v3.1/templates/formbyreference/:reference

Path Parameters

Name	Type	Description
reference	string	the Reference Code of any Form

200

/formbycodename

GET https://api.nexx.cloud/v3.1/templates/formbycodename/:codename

Path Parameters

Name	Type	Description
codename	string	the Codename of any Form

200

Poll Templates

/pollbyid

GET https://api.nexx.cloud/v3.1/templates/pollbyid/:pollid

Path Parameters

Name	Type	Description
pollid	string	the ID of the target Poll

200

/pollbyreference

GET https://api.nexx.cloud/v3.1/templates/pollbyreference/:reference

Path Parameters

Name	Type	Description
reference	string	the Reference Code of any Poll

200

/pollbycodename

GET https://api.nexx.cloud/v3.1/templates/pollbyreference/:codename

Path Parameters

Name	Type	Description
codename	string	the Codename of any Poll

200

/openpoll

GET https://api.nexx.cloud/v3.1/templates/openpoll

This Endpoint will simply return the oldest active and valid Poll for the calling Domain.

200

Voting Templates

/votingbyid

GET https://api.nexx.cloud/v3.1/templates/votingbyid/:votingid

Path Parameters

Name	Type	Description
votingid	string	the ID of the target Voting

200

/votingbyreference

GET https://api.nexx.cloud/v3.1/templates/votingbyreference/:reference

Path Parameters

Name	Type	Description
reference	string	the Reference Code of any Voting

200

/votingbycodename

GET https://api.nexx.cloud/v3.1/templates/votingbyreference/:codename

Path Parameters

Name	Type	Description
codename	string	the Codename of any Voting

200

/openvoting

GET https://api.nexx.cloud/v3.1/templates/openvoting

This Endpoint will simply return the oldest active and valid Voting for the calling Domain.

200