DynamicTemplates

HTML based templates with fields to fill


Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
body body object true Template metadata and sources (TMPL and JSON files) for each language

Request body - Content-Type: multipart/form-data

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
metadata:
  external_id: factura_bilingue_premium
  description: Plantilla para facturas en Español e Inglés.
  default_language: ES
  tags:
    - factura
    - multi-idioma
  sources:
    - language: ES
      template_part: string
      editor_config_part: string

Name Type Required Description
metadata object true none

Request example

1
2
3
4
5
6

curl -X POST https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -F "metadata=undefined" \

Responses

Code Meaning Description Schema
201 Created New dynamic template is created. Expected response for a valid request. CreateDynamicTemplateResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
409 Conflict Conflict. External ID already exists None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
page query Page1 false Defines templates page number to be show. If not defined, default value is 0 (first page).
page_size query PageSize1 false Defines the number of templates returned in each page. If not defined, default value is 50.

Request example

1
2
3
4

curl -X GET https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates?page='0'&page_size='20' \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK The templates list is returned. Expected response for a valid request. GetAllDynamicTemplatesResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
major_version path integer true The major version number

Request example

1
2
3
4

curl -X GET https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1 \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK The template versions are returned. Expected response for a valid request. GetDynamicTemplateVersionsResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template or version not found None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
major_version path integer true The major version number
body body object true Template metadata and sources for creating a minor version

Request body - Content-Type: multipart/form-data

Custom schema example

1
2
3
4
5
6
7
8
metadata:
  description: Plantilla actualizada con soporte para Catalán.
  sources:
    - language: ES
      template_part: string
      editor_config_part: string
  changelog: Added Catalan language support

Name Type Required Description
metadata object true none

Request example

1
2
3
4
5
6

curl -X PATCH https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1 \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -F "metadata=undefined" \

Responses

Code Meaning Description Schema
200 OK New minor version is created. Expected response for a valid request. CreateDynamicTemplateResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template not found None
409 Conflict Breaking changes detected. Use major version endpoint instead. None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
major_version path integer true The major version number

Request example

1
2
3
4

curl -X DELETE https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1 \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
204 No Content Major version deleted successfully None
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template or version not found None
409 Conflict Cannot delete. Not the latest major version. None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
major_version path integer true The major version number
minor_version path integer true The minor version number

Request example

1
2
3
4

curl -X GET https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1/minors/1 \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK The specific template version details are returned. Expected response for a valid request. DynamicTemplateDetails
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template or version not found None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
body body object true Template metadata and sources for creating a major version

Request body - Content-Type: multipart/form-data

Custom schema example

1
2
3
4
5
6
7
8
9
metadata:
  description: Plantilla para facturas en Español e Inglés.
  default_language: ES
  languages:
    - language: ES
      template_part: string
      editor_config_part: string
  changelog: Added discount field and removed unused languages

Name Type Required Description
metadata object true none

Request example

1
2
3
4
5
6

curl -X POST https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -F "metadata=undefined" \

Responses

Code Meaning Description Schema
201 Created New major version is created. Expected response for a valid request. CreateDynamicTemplateResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template not found None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template
major_version path integer true The major version number

Request example

1
2
3
4

curl -X DELETE https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1/minor \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
204 No Content Minor version deleted successfully None
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template or version not found None
409 Conflict Cannot delete base version (X.0) or only minor version in major line None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of Grupo MasOrange tenants
external_id path string true The external id of the dynamic template

Request example

1
2
3
4

curl -X GET https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/changelog \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK The template changelog history is returned. Expected response for a valid request. DynamicTemplateChangelogResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have failed None
404 Not Found Template not found None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Endpoints

Documents

    Forms

      Sections

        Templates

          Templates Configuration

            DynamicTemplates

              Digital Sign Process

                Biometric Signature

                  Simple Signature

                    Identification Agent

                      Sign Configuration

                        Identification OTP

                          Identification with identity document

                            Identification Agent Admin

                              Identification OTP Admin

                                Identification with identity document Admin

                                  Contracts

                                    Scoring

                                      Securize

                                        Identification Chain

                                          Identification Chain Admin