Get All Valid Communication Template
get
/obedm-correspondence-services/commtemplate
This endpoint is used to get all valid Communication Template Maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStat(optional): string
Auth Status of the Communication Template to be fetched
-
communicationCode(optional): string
Code of the Communication Template to be fetched
-
communicationDesc(optional): string
Description of the Communication Template to be fetched
-
communicationMode(optional): string
Mode of the Communication Template to be fetched
-
includecloseandunauth(optional): boolean
Include close and unauthorized value need to be provided to fetch summary record, default value is false.
-
limit(optional): integer
Limit is maximum number of records to be fetched
-
offset(optional): integer
Offset is starting number of records to be fetched
-
recordStat(optional): string
Record Status of the call Action to be fetched
Header Parameters
-
appId: string
The application ID of host service.
-
branchCode: string
The branch code of requesting branch.
-
contentType(optional): string
The content type of request or response body.
-
userId: string
The user ID of requesting user.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created Communication Template
Root Schema : DmTmCommTemplateCollection
Type:
object
Collection of Communication Template.
Show Source
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : DmTmCommTemplateDTO-allOf[1]
Type:
Show Source
object
-
applicability(optional):
string
Applicability
-
attachmentCd(optional):
string
Attachment Code
-
blockPeriod(optional):
integer
Block Period
-
communicationCode(optional):
string
Communication Code
-
communicationDesc(optional):
string
Communication Desc
-
communicationMode(optional):
string
Communication Mode
-
communicationPurposeCode(optional):
string
Communication Purpose Code
-
DmTmCommunicationRecipientDTO(optional):
array DmTmCommunicationRecipientDTO
Collection of list of Recipients.
-
effectiveDt(optional):
string
Effective Date
-
executionType(optional):
string
Execution Type
-
expiryDt(optional):
string
Expiry Date
-
message(optional):
string
Message
-
ruleId(optional):
string
Rule ID
-
subject(optional):
string
Subject
Nested Schema : DmTmCommunicationRecipientDTO
Type:
array
Collection of list of Recipients.
Show Source
Nested Schema : DmTmCommunicationRecipientDTO
Type:
Show Source
object
-
commtemplateMasterId(optional):
string
Commtemplate Master ID
-
id(optional):
string
ID
-
recipientType(optional):
string
Recipient Type
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error