Retrieve Communication Template by ID
get
/obedm-correspondence-services/commtemplate/{id}
This endpoint is used to retrieve the Communication Template by ID.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: string
ID of the record that needs to be fetched
Query Parameters
-
version: string
Version ID of the record that needs 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
200 Response
Returns the Communication Template based on given id.
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.
500 Response
Internal error