template-types

Operations addressed under /template-types — 24 operations.

Get Template Management Type List

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-template-type-list service definition through GET /template-types.

Response body, read from the service source

The route declares its response as IEnumerable<TemplateTypeDto>.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`DocumentFormat`	`int?`	yes
`CategoryType`	`int?`	yes
`Tools`	`IEnumerable<TemplateTypeToolbarItem>` (collection)	no

Member names are the service's declaration names.

Get Template Management Type List › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

Get Template Management Type List › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

Create Template Type

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the create-template-type service definition through POST /template-types.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Create Template Type › Request Body

description

string · required

documentFormat

integer · int32 · required

Permitted values — validated against the document_format parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Docx`	no label seeded
`2`	`Html`	ar: إتش تي إم إل
`3`	`Pdf`	ar: ملف PDF
`4`	`Doc`	ar: تنسيق مستند ورد 97-2003
`5`	`Dot`	ar: تنسيق قالب Microsoft Word 97-2003
`6`	`StrictDocx`	ar: تنسيق مستند وورد صارم من مايكروسوفت
`7`	`Word2007`	ar: صيغة مستند مايكروسوفت وورد 2007
`8`	`Word2010`	ar: صيغة مستندات Microsoft Word 2010
`9`	`Word2013`	ar: صيغة مستندات Microsoft Word 2013
`10`	`Word2007Dotx`	ar: تنسيق قالب Microsoft Word 2007
`11`	`Word2010Dotx`	ar: تنسيق قالب مايكروسوفت وورد 2010
`12`	`Word2013Dotx`	ar: نمذج قالب مايكروسوفت وورد 2013
`13`	`Dotx`	ar: نموذج قالب مايكروسوفت وورد
`14`	`Word2007Docm`	ar: تنسيق ملف ماكرو مفعّل في Microsoft Word 2007
`15`	`Word2010Docm`	ar: صيغة ملف ماكرو ممكنة في Microsoft Word 2010
`16`	`Word2013Docm`	ar: صيغة ملف ماكرو مفعّل في Microsoft Word 2013
`17`	`Docm`	ar: تنسيق ملف ماكرو مقرَّب في Microsoft Word
`18`	`Word2007Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2007
`19`	`Word2010Dotm`	ar: تنسيق قالب ماكرو مُمَكَّن في Microsoft Word 2010
`20`	`Word2013Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2013
`21`	`Dotm`	ar: تنسيق قالب ماكرو مفعّل في مايكروسوفت وورد
`22`	`WordML`	ar: تحدد مستندات WordProcessingML (.XML)
`23`	`Rtf`	ar: تنسيق النص الغني (RTF)
`24`	`Txt`	ar: تنسيق النص لنظام مايكروسوفت ويندوز
`25`	`Markdown`	ar: عضوية
`26`	`Automatic`	ar: دعم جميع أنواع التنسيقات
`27`	`Odt`	ar: يحفظ المستند Word بتنسيق النص المفتوح

name

string · required

tools

integer[] · required

Permitted values — validated against the toolbar_list parameter. The service rejects any other value.

Value	Token	Labels
`1`	`New`	no label seeded
`2`	`Open`	no label seeded
`3`	`Undo`	no label seeded
`4`	`Redo`	no label seeded
`5`	`Comments`	no label seeded
`6`	`Image`	ar: صورة
`7`	`Table`	ar: جدول
`8`	`Hyperlink`	ar: الرابط التشعبي
`9`	`Bookmark`	ar: علامة مرجعية
`10`	`TableOfContents`	ar: جدول المحتويات
`11`	`Header`	ar: رأس الصفحة
`12`	`Footer`	ar: التذييل
`13`	`PageSetup`	ar: إعداد الصفحة
`14`	`PageNumber`	ar: رقم الصفحة
`15`	`Break`	ar: استراحة
`16`	`Find`	ar: ابحث
`17`	`LocalClipboard`	ar: الحافظة المحلية
`18`	`RestrictEditing`	ar: تقييد التحرير
`19`	`InsertField`	ar: إدراج حقل جدول
`20`	`FormFields`	en: Form Fields · tr: Form Alanları · ar: حقول النموذج

categoryType

integer · int32

Create Template Type › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

create-and-upload-document

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/designs/create-and-upload-document/{templateDesignId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

create-and-upload-document › path Parameters

templateDesignId

string · uuid · required

create-and-upload-document › Request Body

object · required

create-and-upload-document › Responses

No data returned

POST/template-types/designs/create-and-upload-document/{templateDesignId}

curl https://dg-sandbox.dgpays.com/template-management-service/template-types/designs/create-and-upload-document/:templateDesignId \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "generateDocumentParams": {
    "designVariables": {},
    "languageCode": ""
  },
  "uploadDocumentParams": {
    "aspectProperties": {},
    "cmisProvider": 0,
    "customTypeProperties": {},
    "description": "",
    "documentName": "",
    "folderPath": "",
    "mimeType": 0,
    "versionType": 0
  }
}'

Example Request Body

{
  "generateDocumentParams": {
    "designVariables": {},
    "languageCode": ""
  },
  "uploadDocumentParams": {
    "aspectProperties": {},
    "cmisProvider": 0,
    "customTypeProperties": {},
    "description": "",
    "documentName": "",
    "folderPath": "",
    "mimeType": 0,
    "versionType": 0
  }
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

create-document-list-by-code-with-template

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/designs/create-documents-by-code/{templateDesignCode}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as CreateDocumentListDto.

Field	Declared type	Nullable
`TemplateDesignCode`	`string`	no
`ContextVersion`	`string`	no
`DocumentContextList`	`List<Dictionary<string, string>>` (collection)	no

Member names are the service's declaration names.

create-document-list-by-code-with-template › path Parameters

templateDesignCode

string · required

create-document-list-by-code-with-template › Request Body

contextFields

string[] · required

referenceFieldCode

string · required

object[]

isResponseClear

boolean

languageCode

string

create-document-list-by-code-with-template › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/template-types/designs/create-documents-by-code/{templateDesignCode}

curl https://dg-sandbox.dgpays.com/template-management-service/template-types/designs/create-documents-by-code/:templateDesignCode \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "commonFieldsPriority": [
    {
      "fieldCode": "",
      "listName": ""
    }
  ],
  "contextFields": [
    ""
  ],
  "isResponseClear": false,
  "languageCode": "",
  "referenceFieldCode": ""
}'

Example Request Body

{
  "commonFieldsPriority": [
    {
      "fieldCode": "",
      "listName": ""
    }
  ],
  "contextFields": [
    ""
  ],
  "isResponseClear": false,
  "languageCode": "",
  "referenceFieldCode": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

create-document-list-with-template

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/designs/create-documents/{templateDesignId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as CreateDocumentListDto.

Field	Declared type	Nullable
`TemplateDesignCode`	`string`	no
`ContextVersion`	`string`	no
`DocumentContextList`	`List<Dictionary<string, string>>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_18`	400	`ARRAY_FIELD_NOT_FOUND_IN_PROCESS_VARIABLES`	Array field cannot be found in process variables
`ERR_TMPLMNG_19`	400	`REFERENCE_FIELD_NOT_FOUND_IN_ARRAY_ITEM`	Reference field cannot be found in array item
`ERR_TMPLMNG_20`	400	`ARRAYS_REFERENCE_VALUES_DONT_MATCH`	Arrays reference values dont match
`ERR_TMPLMNG_21`	400	`ARRAY_HAS_SAME_REFERENCE_VALUE`	Array has same reference value

create-document-list-with-template › path Parameters

templateDesignId

string · uuid · required

create-document-list-with-template › Request Body

contextFields

string[] · required

referenceFieldCode

string · required

object[]

isResponseClear

boolean

languageCode

string

create-document-list-with-template › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/template-types/designs/create-documents/{templateDesignId}

curl https://dg-sandbox.dgpays.com/template-management-service/template-types/designs/create-documents/:templateDesignId \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "commonFieldsPriority": [
    {
      "fieldCode": "",
      "listName": ""
    }
  ],
  "contextFields": [
    ""
  ],
  "isResponseClear": false,
  "languageCode": "",
  "referenceFieldCode": ""
}'

Example Request Body

{
  "commonFieldsPriority": [
    {
      "fieldCode": "",
      "listName": ""
    }
  ],
  "contextFields": [
    ""
  ],
  "isResponseClear": false,
  "languageCode": "",
  "referenceFieldCode": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-template-type-by-id

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateTypeDto.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`DocumentFormat`	`int?`	yes
`CategoryType`	`int?`	yes
`Tools`	`IEnumerable<TemplateTypeToolbarItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.

get-template-type-by-id › path Parameters

id

string · uuid · required

get-template-type-by-id › Responses

Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.

categoryType

integer · int32

description

string

documentFormat

integer · int32

Permitted values — validated against the document_format parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Docx`	no label seeded
`2`	`Html`	ar: إتش تي إم إل
`3`	`Pdf`	ar: ملف PDF
`4`	`Doc`	ar: تنسيق مستند ورد 97-2003
`5`	`Dot`	ar: تنسيق قالب Microsoft Word 97-2003
`6`	`StrictDocx`	ar: تنسيق مستند وورد صارم من مايكروسوفت
`7`	`Word2007`	ar: صيغة مستند مايكروسوفت وورد 2007
`8`	`Word2010`	ar: صيغة مستندات Microsoft Word 2010
`9`	`Word2013`	ar: صيغة مستندات Microsoft Word 2013
`10`	`Word2007Dotx`	ar: تنسيق قالب Microsoft Word 2007
`11`	`Word2010Dotx`	ar: تنسيق قالب مايكروسوفت وورد 2010
`12`	`Word2013Dotx`	ar: نمذج قالب مايكروسوفت وورد 2013
`13`	`Dotx`	ar: نموذج قالب مايكروسوفت وورد
`14`	`Word2007Docm`	ar: تنسيق ملف ماكرو مفعّل في Microsoft Word 2007
`15`	`Word2010Docm`	ar: صيغة ملف ماكرو ممكنة في Microsoft Word 2010
`16`	`Word2013Docm`	ar: صيغة ملف ماكرو مفعّل في Microsoft Word 2013
`17`	`Docm`	ar: تنسيق ملف ماكرو مقرَّب في Microsoft Word
`18`	`Word2007Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2007
`19`	`Word2010Dotm`	ar: تنسيق قالب ماكرو مُمَكَّن في Microsoft Word 2010
`20`	`Word2013Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2013
`21`	`Dotm`	ar: تنسيق قالب ماكرو مفعّل في مايكروسوفت وورد
`22`	`WordML`	ar: تحدد مستندات WordProcessingML (.XML)
`23`	`Rtf`	ar: تنسيق النص الغني (RTF)
`24`	`Txt`	ar: تنسيق النص لنظام مايكروسوفت ويندوز
`25`	`Markdown`	ar: عضوية
`26`	`Automatic`	ar: دعم جميع أنواع التنسيقات
`27`	`Odt`	ar: يحفظ المستند Word بتنسيق النص المفتوح

id

string · uuid

name

string

object[]

Permitted values — validated against the toolbar_list parameter. The service rejects any other value.

Value	Token	Labels
`1`	`New`	no label seeded
`2`	`Open`	no label seeded
`3`	`Undo`	no label seeded
`4`	`Redo`	no label seeded
`5`	`Comments`	no label seeded
`6`	`Image`	ar: صورة
`7`	`Table`	ar: جدول
`8`	`Hyperlink`	ar: الرابط التشعبي
`9`	`Bookmark`	ar: علامة مرجعية
`10`	`TableOfContents`	ar: جدول المحتويات
`11`	`Header`	ar: رأس الصفحة
`12`	`Footer`	ar: التذييل
`13`	`PageSetup`	ar: إعداد الصفحة
`14`	`PageNumber`	ar: رقم الصفحة
`15`	`Break`	ar: استراحة
`16`	`Find`	ar: ابحث
`17`	`LocalClipboard`	ar: الحافظة المحلية
`18`	`RestrictEditing`	ar: تقييد التحرير
`19`	`InsertField`	ar: إدراج حقل جدول
`20`	`FormFields`	en: Form Fields · tr: Form Alanları · ar: حقول النموذج

Update Template Type

PUT

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the update-template-type service definition through PUT /template-types/{id}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.

Update Template Type › path Parameters

id

string · uuid · required

Update Template Type › Request Body

description

string · required

documentFormat

integer · int32 · required

Permitted values — validated against the document_format parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Docx`	no label seeded
`2`	`Html`	ar: إتش تي إم إل
`3`	`Pdf`	ar: ملف PDF
`4`	`Doc`	ar: تنسيق مستند ورد 97-2003
`5`	`Dot`	ar: تنسيق قالب Microsoft Word 97-2003
`6`	`StrictDocx`	ar: تنسيق مستند وورد صارم من مايكروسوفت
`7`	`Word2007`	ar: صيغة مستند مايكروسوفت وورد 2007
`8`	`Word2010`	ar: صيغة مستندات Microsoft Word 2010
`9`	`Word2013`	ar: صيغة مستندات Microsoft Word 2013
`10`	`Word2007Dotx`	ar: تنسيق قالب Microsoft Word 2007
`11`	`Word2010Dotx`	ar: تنسيق قالب مايكروسوفت وورد 2010
`12`	`Word2013Dotx`	ar: نمذج قالب مايكروسوفت وورد 2013
`13`	`Dotx`	ar: نموذج قالب مايكروسوفت وورد
`14`	`Word2007Docm`	ar: تنسيق ملف ماكرو مفعّل في Microsoft Word 2007
`15`	`Word2010Docm`	ar: صيغة ملف ماكرو ممكنة في Microsoft Word 2010
`16`	`Word2013Docm`	ar: صيغة ملف ماكرو مفعّل في Microsoft Word 2013
`17`	`Docm`	ar: تنسيق ملف ماكرو مقرَّب في Microsoft Word
`18`	`Word2007Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2007
`19`	`Word2010Dotm`	ar: تنسيق قالب ماكرو مُمَكَّن في Microsoft Word 2010
`20`	`Word2013Dotm`	ar: تنسيق قالب ماكرو مفعّل في Microsoft Word 2013
`21`	`Dotm`	ar: تنسيق قالب ماكرو مفعّل في مايكروسوفت وورد
`22`	`WordML`	ar: تحدد مستندات WordProcessingML (.XML)
`23`	`Rtf`	ar: تنسيق النص الغني (RTF)
`24`	`Txt`	ar: تنسيق النص لنظام مايكروسوفت ويندوز
`25`	`Markdown`	ar: عضوية
`26`	`Automatic`	ar: دعم جميع أنواع التنسيقات
`27`	`Odt`	ar: يحفظ المستند Word بتنسيق النص المفتوح

name

string · required

categoryType

integer · int32

Update Template Type › Responses

No data returned

Delete Template Type

DELETE

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the delete-template-type service definition through DELETE /template-types/{id}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_3`	400	`TEMPLATE_TYPE_USED_IN_TEMPLATE_DESIGN_CAN_NOT_BE_DELETED`	There are template designs generated with this template type. Template type cannot be deleted.

Delete Template Type › path Parameters

id

string · uuid · required

Delete Template Type › Responses

No data returned

Get Template Management Design List

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-template-design-list service definition through GET /template-types/{id}/designs.

Response body, read from the service source

The route declares its response as IEnumerable<TemplateDesignDto>.

Field	Declared type	Nullable
`TemplateDesignId`	`Guid?`	yes
`Code`	`string`	no
`Description`	`string`	no
`IsImmediateDesign`	`bool?`	yes
`ActiveContextVersion`	`string`	no
`TemplateDesignExtensions`	`Dictionary<string, string>`	no
`TemplateDesignFields`	`IEnumerable<TemplateDesignFieldItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.

Get Template Management Design List › path Parameters

id

string · uuid · required

Get Template Management Design List › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

Get Template Management Design List › Responses

No data returned

create-template-design

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateDesignCommandDto.

Field	Declared type	Nullable
`TemplateDesignId`	`Guid?`	yes

Member names are the service's declaration names.

create-template-design › path Parameters

id

string · uuid · required

create-template-design › Request Body

code

string · required

description

string · required

isImmediateDesign

boolean · required

object[] · required

create-template-design › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/template-types/{id}/designs

curl https://dg-sandbox.dgpays.com/template-management-service/template-types/:id/designs \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "description": "",
  "isImmediateDesign": false,
  "templateDesignFields": [
    {
      "fieldDefinitionId": "",
      "isMandatory": false
    }
  ]
}'

Example Request Body

{
  "code": "",
  "description": "",
  "isImmediateDesign": false,
  "templateDesignFields": [
    {
      "fieldDefinitionId": "",
      "isMandatory": false
    }
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-template-design-by-id

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateDesignDto.

Field	Declared type	Nullable
`TemplateDesignId`	`Guid?`	yes
`Code`	`string`	no
`Description`	`string`	no
`IsImmediateDesign`	`bool?`	yes
`ActiveContextVersion`	`string`	no
`TemplateDesignExtensions`	`Dictionary<string, string>`	no
`TemplateDesignFields`	`IEnumerable<TemplateDesignFieldItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

get-template-design-by-id › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

get-template-design-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-template-design

PUT

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

update-template-design › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

update-template-design › Request Body

code

string · required

description

string · required

isImmediateDesign

boolean · required

update-template-design › Responses

No data returned

delete-template-design

DELETE

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_16`	400	`TEMPLATE_DESIGN_CONTEXT_FOUND`	It cannot be deleted. Because there is a content produced with the given:`{0}`.
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

delete-template-design › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

delete-template-design › Responses

No data returned

Create Template Design Context

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the create-template-design-context service definition through POST /template-types/{id}/designs/{templateDesignId}/contexts.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_9`	400	`TEMPLATE_DESIGN_CONTEXT_SAME_VERSION`	It is not allowed to have more than one context with the same version.

Create Template Design Context › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

Create Template Design Context › Request Body

context

string · required

isDefault

boolean · required

languageCode

string · required

Create Template Design Context › Responses

No data returned

Get Template Management Design Context List

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-template-design-context-list service definition through GET /template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}.

Response body, read from the service source

The route declares its response as IEnumerable<DesignContextDto>.

Field	Declared type	Nullable
`TemplateDesignContextId`	`Guid`	no
`ContextVersion`	`string`	no
`IsActive`	`bool`	no
`IsDefault`	`bool?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

Get Template Management Design Context List › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

languageCode

string · required

Get Template Management Design Context List › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

Get Template Management Design Context List › Responses

No data returned

get-template-design-active-context

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}/active-version

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateDesignContextDto.

Field	Declared type	Nullable
`TemplateDesignContextId`	`Guid`	no
`ContextVersion`	`string`	no
`Context`	`string`	no
`LanguageCode`	`string`	no
`IsActive`	`bool`	no
`IsDefault`	`bool?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_10`	400	`TEMPLATE_DESIGN_ACTIVE_CONTEXT_NOT_FOUND`	Active version is cannot be found for the given template design:`{0}`.
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

get-template-design-active-context › path Parameters

id

required

templateDesignId

string · uuid · required

languageCode

string · required

get-template-design-active-context › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

Get Template Management Design Context By Id

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-template-design-context-by-id service definition through GET /template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}.

Response body, read from the service source

The route declares its response as TemplateDesignContextAndEntitiesDto.

Field	Declared type	Nullable
`TemplateDesignContextId`	`Guid`	no
`ContextVersion`	`string`	no
`Context`	`string`	no
`LanguageCode`	`string`	no
`IsActive`	`bool`	no
`IsDefault`	`bool?`	yes
`TemplateDesignFields`	`List<string>` (collection)	no
`TemplateDesignTools`	`List<string>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_8`	400	`TEMPLATE_DESIGN_CONTEXT_NOT_FOUND`	Template design context is cannot be found with the given: `{0}`.

Get Template Management Design Context By Id › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

templateDesignContextId

string · uuid · required

Get Template Management Design Context By Id › Responses

No data returned

Update Template Design Context

PUT

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the update-template-design-context service definition through PUT /template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_12`	400	`TEMPLATE_DESIGN_CONTEXT_ACTIVE_NOT_FOUND`	It is not allowed to update an inactive context.
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_8`	400	`TEMPLATE_DESIGN_CONTEXT_NOT_FOUND`	Template design context is cannot be found with the given: `{0}`.

Update Template Design Context › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

templateDesignContextId

string · uuid · required

Update Template Design Context › Request Body

context

string · required

isDefault

boolean · required

Update Template Design Context › Responses

No data returned

Update Template Design Context Status

PUT

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}/active

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the update-template-design-context-status service definition through PUT /template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}/active.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_8`	400	`TEMPLATE_DESIGN_CONTEXT_NOT_FOUND`	Template design context is cannot be found with the given: `{0}`.

Update Template Design Context Status › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

templateDesignContextId

string · uuid · required

Update Template Design Context Status › Request Body

isActive

boolean · required

Update Template Design Context Status › Responses

No data returned

create-template-design-field

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/fields

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateDesignFieldDto.

Field	Declared type	Nullable
`TemplateDesignFieldId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_7`	400	`TEMPLATE_DESIGN_FIELD_USED_ANOTHER_TEMPLATE_DESIGN`	Field `{0}` is already related with template design. It cannot be used twice.

create-template-design-field › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

create-template-design-field › Request Body

fieldDefinitionId

string · uuid · required

isMandatory

boolean

create-template-design-field › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-template-design-fields-and-tools

GET

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/fields-and-tools

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as TemplateDesignContextAndEntitiesDto.

Field	Declared type	Nullable
`TemplateDesignContextId`	`Guid`	no
`ContextVersion`	`string`	no
`Context`	`string`	no
`LanguageCode`	`string`	no
`IsActive`	`bool`	no
`IsDefault`	`bool?`	yes
`TemplateDesignFields`	`List<string>` (collection)	no
`TemplateDesignTools`	`List<string>` (collection)	no

Member names are the service's declaration names.

get-template-design-fields-and-tools › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

get-template-design-fields-and-tools › Responses

No data returned

update-template-design-field

PUT

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/designs/{templateDesignId}/fields/{templateDesignFieldId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_17`	400	`TEMPLATE_DESIGN_FIELD_IS_NOT_FOUND`	Template design field is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_6`	400	`TEMPLATE_DESIGN_NOT_FOUND`	Template design is cannot be found with the given :`{0}`.

update-template-design-field › path Parameters

id

string · uuid · required

templateDesignId

string · uuid · required

templateDesignFieldId

string · uuid · required

update-template-design-field › Request Body

isMandatory

boolean · required

update-template-design-field › Responses

No data returned

create-template-type-tool

POST

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/tools

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_11`	400	`TEMPLATE_DESIGN_TOOL_ALREADY_EXISTS`	Tools: `{0}` already in use template type.
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.

create-template-type-tool › path Parameters

id

string · uuid · required

create-template-type-tool › Request Body

tools

integer[] · required

Permitted values — validated against the toolbar_list parameter. The service rejects any other value.

Value	Token	Labels
`1`	`New`	no label seeded
`2`	`Open`	no label seeded
`3`	`Undo`	no label seeded
`4`	`Redo`	no label seeded
`5`	`Comments`	no label seeded
`6`	`Image`	ar: صورة
`7`	`Table`	ar: جدول
`8`	`Hyperlink`	ar: الرابط التشعبي
`9`	`Bookmark`	ar: علامة مرجعية
`10`	`TableOfContents`	ar: جدول المحتويات
`11`	`Header`	ar: رأس الصفحة
`12`	`Footer`	ar: التذييل
`13`	`PageSetup`	ar: إعداد الصفحة
`14`	`PageNumber`	ar: رقم الصفحة
`15`	`Break`	ar: استراحة
`16`	`Find`	ar: ابحث
`17`	`LocalClipboard`	ar: الحافظة المحلية
`18`	`RestrictEditing`	ar: تقييد التحرير
`19`	`InsertField`	ar: إدراج حقل جدول
`20`	`FormFields`	en: Form Fields · tr: Form Alanları · ar: حقول النموذج

create-template-type-tool › Responses

No data returned

delete-template-type-tool

DELETE

https://dg-sandbox.dgpays.com/template-management-service

/template-types/{id}/tools/by-tool/{tool}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_TMPLMNG_2`	400	`TEMPLATE_TYPE_NOT_FOUND`	Template type is cannot be found with the given :`{0}`.
`ERR_TMPLMNG_4`	400	`TEMPLATE_TYPE_TOOL_NOT_FOUND`	Template type tool is cannot be found with the given :`{0}`.

delete-template-type-tool › path Parameters

id

string · uuid · required

tool

integer · int32 · required

delete-template-type-tool › Responses

No data returned

parameters