Jump to

• Request
• Response

Get All Valid Product Processors

get

/obedm-common-services/productprocessor

This endpoint is use to get all valid product processor maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Authentication Status that needs to be fetched.
• includecloseandunauth(optional): boolean
  Include close and unauthorised need to be set 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.
• pprDesc(optional): string
  Product Processor that needs to be fetched.
• pprGroupBasisCd(optional): string
  Group Basis Code that needs to be fetched.
• pprProdProcessor(optional): string
  Product Processor that needs to be fetched.
• recordStat(optional): string
  Record Status that needs to be fetched.

Header Parameters

• appId: string
  The ID of the Application.
• branchCode: string
  The branch code associated with the request.
• contentType(optional): string
  The Content Type of the request.
• tenantId(optional): string
  The ID of the Tenant.
• userId: string
  The ID of the User.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Additional information of the product processor.

Body ()

Root Schema : DmTmProductProcessorCollection

Type: object

Collection of product processor.

Show Source

• data(optional): array data
  An array of product processor objects.
• paging(optional): object PagingDto

{
    "description":"Collection of product processor.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"An array of product processor objects.",
            "items":{
                "$ref":"#/definitions/DmTmProductProcessorDTO"
            }
        },
        "paging":{
            "description":"The paging information for the collection.",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

An array of product processor objects.

Show Source

• Array of: object DmTmProductProcessorDTO

{
    "type":"array",
    "description":"An array of product processor objects.",
    "items":{
        "$ref":"#/definitions/DmTmProductProcessorDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : DmTmProductProcessorDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmProductProcessorDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "productProcessorCd":{
                    "description":"Code that uniquely identifies the product processor.",
                    "type":"string"
                },
                "productProcessorDesc":{
                    "description":"Description of the product processor.",
                    "type":"string"
                },
                "groupBasisCd":{
                    "description":"Code that identifies the group basis to which the product processor belongs.",
                    "type":"string"
                },
                "autoPopPtcCompanyInd":{
                    "description":"Indicates whether PTC company details should be automatically populated or not.",
                    "type":"boolean"
                },
                "effectiveDt":{
                    "description":"Effective date of the product processor.",
                    "type":"string"
                },
                "expiryDt":{
                    "description":"Expiry date of the product processor.",
                    "type":"string"
                },
                "bureauInt":{
                    "description":"Indicates whether bureau integration is required for the product processor or not.",
                    "type":"boolean"
                },
                "decisionSvc":{
                    "description":"Indicates whether decision service is required for the product processor or not.",
                    "type":"boolean"
                },
                "DmTmProductProcessorExtnDTO":{
                    "description":"List of extended attributes for the product processor.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmProductProcessorDTO-allOf[1]

Type: object

Show Source

• autoPopPtcCompanyInd(optional): boolean
  Indicates whether PTC company details should be automatically populated or not.
• bureauInt(optional): boolean
  Indicates whether bureau integration is required for the product processor or not.
• decisionSvc(optional): boolean
  Indicates whether decision service is required for the product processor or not.
• DmTmProductProcessorExtnDTO(optional): array DmTmProductProcessorExtnDTO
  List of extended attributes for the product processor.
• effectiveDt(optional): string
  Effective date of the product processor.
• expiryDt(optional): string
  Expiry date of the product processor.
• groupBasisCd(optional): string
  Code that identifies the group basis to which the product processor belongs.
• productProcessorCd(optional): string
  Code that uniquely identifies the product processor.
• productProcessorDesc(optional): string
  Description of the product processor.

{
    "type":"object",
    "properties":{
        "productProcessorCd":{
            "description":"Code that uniquely identifies the product processor.",
            "type":"string"
        },
        "productProcessorDesc":{
            "description":"Description of the product processor.",
            "type":"string"
        },
        "groupBasisCd":{
            "description":"Code that identifies the group basis to which the product processor belongs.",
            "type":"string"
        },
        "autoPopPtcCompanyInd":{
            "description":"Indicates whether PTC company details should be automatically populated or not.",
            "type":"boolean"
        },
        "effectiveDt":{
            "description":"Effective date of the product processor.",
            "type":"string"
        },
        "expiryDt":{
            "description":"Expiry date of the product processor.",
            "type":"string"
        },
        "bureauInt":{
            "description":"Indicates whether bureau integration is required for the product processor or not.",
            "type":"boolean"
        },
        "decisionSvc":{
            "description":"Indicates whether decision service is required for the product processor or not.",
            "type":"boolean"
        },
        "DmTmProductProcessorExtnDTO":{
            "description":"List of extended attributes for the product processor.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
            }
        }
    }
}

Nested Schema : DmTmProductProcessorExtnDTO

Type: array

List of extended attributes for the product processor.

Show Source

• Array of: object DmTmProductProcessorExtnDTO

{
    "description":"List of extended attributes for the product processor.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
    }
}

Nested Schema : DmTmProductProcessorExtnDTO

Type: object

Show Source

• attrType(optional): string
  Maximum Length: 30

  The attribute type.
• attrValue(optional): string
  Maximum Length: 100

  The attribute value.
• id(optional): string
  The unique identifier.
• productProcessorMasterId(optional): string
  The unique identifier of the product processor master.

{
    "type":"object",
    "properties":{
        "attrType":{
            "description":"The attribute type.",
            "type":"string",
            "maxLength":30
        },
        "attrValue":{
            "description":"The attribute value.",
            "type":"string",
            "maxLength":100
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        },
        "productProcessorMasterId":{
            "type":"string",
            "description":"The unique identifier of the product processor master."
        }
    }
}

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