Jump to

• Request
• Response

Retrieve Onload Data

get

/obedm-correspondence-services/commtemplate/onload

This endpoint is used to retrieve the onload data.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• seedTypCd: string
  Code of the Seed data type 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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the Communication Template based on given id.

Body ()

Root Schema : DmTmCommTemplateOnloadWrapperDTO

Type: object

Collection of list of Communication Template

Show Source

• data(optional): object DmTmCommTemplateOnloadDTO

{
    "type":"object",
    "description":"Collection of list of Communication Template",
    "properties":{
        "data":{
            "$ref":"#/definitions/DmTmCommTemplateOnloadDTO"
        }
    }
}

Nested Schema : DmTmCommTemplateOnloadDTO

Type: object

Show Source

• DmTmCommPurposeDtlsDTO(optional): array DmTmCommPurposeDtlsDTO
  Collection of list of Communication Purpose
• DmTmRecipientDataDtlsDTO(optional): array DmTmRecipientDataDtlsDTO
  Collection of list of Recipient Data
• seedTypeCd(optional): string
  Seed Type Code

{
    "type":"object",
    "properties":{
        "seedTypeCd":{
            "description":"Seed Type Code",
            "type":"string"
        },
        "DmTmRecipientDataDtlsDTO":{
            "type":"array",
            "description":"Collection of list of Recipient Data",
            "items":{
                "$ref":"#/definitions/DmTmRecipientDataDtlsDTO"
            }
        },
        "DmTmCommPurposeDtlsDTO":{
            "type":"array",
            "description":"Collection of list of Communication Purpose",
            "items":{
                "$ref":"#/definitions/DmTmCommPurposeDtlsDTO"
            }
        }
    }
}

Nested Schema : DmTmCommPurposeDtlsDTO

Type: array

Collection of list of Communication Purpose

Show Source

• Array of: object DmTmCommPurposeDtlsDTO

{
    "type":"array",
    "description":"Collection of list of Communication Purpose",
    "items":{
        "$ref":"#/definitions/DmTmCommPurposeDtlsDTO"
    }
}

Nested Schema : DmTmRecipientDataDtlsDTO

Type: array

Collection of list of Recipient Data

Show Source

• Array of: object DmTmRecipientDataDtlsDTO

{
    "type":"array",
    "description":"Collection of list of Recipient Data",
    "items":{
        "$ref":"#/definitions/DmTmRecipientDataDtlsDTO"
    }
}

Nested Schema : DmTmCommPurposeDtlsDTO

Type: object

Show Source

• commPurposeCd(optional): string
  Communication Purpose Code
• description(optional): string
  Description

{
    "type":"object",
    "properties":{
        "commPurposeCd":{
            "description":"Communication Purpose Code",
            "type":"string"
        },
        "description":{
            "description":"Description",
            "type":"string"
        }
    }
}

Nested Schema : DmTmRecipientDataDtlsDTO

Type: object

Show Source

• description(optional): string
  Description
• seedCd(optional): string
  Seed Code

{
    "type":"object",
    "properties":{
        "seedCd":{
            "description":"Seed Code",
            "type":"string"
        },
        "description":{
            "description":"Description",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top