Jump to

• Request
• Response

Fetch promise and its history using promise Id.

get

/obedm-ptp-services/ptp/getPtpById/{ptpId}

This endpoint is used to fetch promise and its history using promise Id, only when an active case is associated with it.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• ptpId(required): string
  Promise Id

Header Parameters

• appId(required): string
  Application ID of promise
• branchCode(required): string
  Branch Code of promise
• contentType: string
  Content Type of promise.
• tenantId: string
  Tenant ID of promise.
• userId(required): string
  User ID of promise.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns ptp details by promise Id.

Headers

• Location: string
  URL of newly created promise

Body ()

Root Schema : DmPTPDto

Type: object

Show Source

• accountId: string
  Account ID for promise
• cancelReasonCode: string
  Cancelled Reason code for PTP
• caseId: string
  Case ID for promise
• createdBy: string
  PTP Created by user id
• createdDtTm: string
  Created PTP date and time
• currencyCode: string
  Currency Code promise
• id: string
  ID of promise
• lastBy: string
  Last updated PTP user
• lastUpdateDtTm: string
  Last time and date update PTP
• notes: string
  Notes of PTP
• promiseAmount: string
  Promise amount promise
• promiseDate: string
  Promise date for PTP
• ptpTransactionDto: array ptpTransactionDto
  PTP transactional Object
• ptpTypeCode: string
  PTP type code promise
• receivedAmount: string
  Received amount promise
• status: string
  Status of PTP
• taskId: string
  Task ID for promise
• taskTypeCd: string
  Task Type Code of the associated task.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of promise",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID for promise",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID for promise",
            "type":"string"
        },
        "ptpTypeCode":{
            "description":"PTP type code promise",
            "type":"string"
        },
        "promiseAmount":{
            "description":"Promise amount promise",
            "type":"string"
        },
        "receivedAmount":{
            "description":"Received amount promise",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code promise",
            "type":"string"
        },
        "status":{
            "description":"Status of PTP",
            "type":"string"
        },
        "promiseDate":{
            "description":"Promise date for PTP",
            "type":"string"
        },
        "cancelReasonCode":{
            "description":"Cancelled Reason code for PTP",
            "type":"string"
        },
        "notes":{
            "description":"Notes of PTP",
            "type":"string"
        },
        "createdBy":{
            "description":"PTP Created by user id",
            "type":"string"
        },
        "createdDtTm":{
            "description":"Created PTP date and time ",
            "type":"string"
        },
        "lastBy":{
            "description":"Last updated PTP user",
            "type":"string"
        },
        "lastUpdateDtTm":{
            "description":"Last time and date update PTP",
            "type":"string"
        },
        "taskTypeCd":{
            "description":"Task Type Code of the associated task.",
            "type":"string"
        },
        "caseId":{
            "description":"Case ID for promise",
            "type":"string"
        },
        "ptpTransactionDto":{
            "type":"array",
            "description":"PTP transactional Object",
            "items":{
                "$ref":"#/definitions/PTPTransactionDto"
            }
        }
    }
}

Nested Schema : ptpTransactionDto

Type: array

PTP transactional Object

Show Source

• Array of: object PTPTransactionDto

{
    "type":"array",
    "description":"PTP transactional Object",
    "items":{
        "$ref":"#/definitions/PTPTransactionDto"
    }
}

Nested Schema : PTPTransactionDto

Type: object

Show Source

• id: string
  The unique identifier for the PTP Transaction.
• origReferenceNumber: string
  The original reference number for the PTP transaction.
• ptpMasterId: string
  The unique identifier for the PTP master record.
• referenceNumber: string
  The reference number for the PTP transaction.
• transactionAmount: string
  The amount of the PTP transaction.
• transactionDate: string
  The date the PTP transaction occurred.
• transactionType: string
  The type of PTP transaction that occurred.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the PTP Transaction.",
            "type":"string"
        },
        "transactionDate":{
            "description":"The date the PTP transaction occurred.",
            "type":"string"
        },
        "transactionType":{
            "description":"The type of PTP transaction that occurred.",
            "type":"string"
        },
        "transactionAmount":{
            "description":"The amount of the PTP transaction.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"The reference number for the PTP transaction.",
            "type":"string"
        },
        "origReferenceNumber":{
            "description":"The original reference number for the PTP transaction.",
            "type":"string"
        },
        "ptpMasterId":{
            "description":"The unique identifier for the PTP master record.",
            "type":"string"
        }
    }
}

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

Back to Top