Get list of Active Card Product Definitions

The method retrieves active versions of the all Card Product Definition. This allows administrators to review CPDs active version and properly manage CPDs development.

URL test:

https://test.lightcms.io/cms/v1/cpds

Method:

GET

Path items:

/cpds (Card Product Definition Service)

?size={size}

&page={page}

&sort={sort}

Parameters:

Parameter	Location	Type	Example	Description	Required
size	query	integer	20	Number of records on the page (default is 20).	No
page	query	integer	0	Page index (starting from 0).	No
sort	query	string	createdAt,desc	Sorting expression – list of “field,direction” pairs; possible fields: code, name, segment, status. Default: createdAt,desc	No

Example:

curl -X 'GET' \
  'https://test.lightcms.io/cms/v1/cpds?page=0&size=20&sort=code%2Casc' \
  -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK

{
  "cpds": [
    {
      "id": 1,
      "code": "VISA_VIRT_2",
      "name": "VISA Virtual Retail",
      "image": [
        "virtual.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    },
    {
      "id": 2,
      "code": "VISA_PHYS_1",
      "name": "VISA Physical Retail",
      "image": [
        "phys_standard.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    },
    {
      "id": 3,
      "code": "VISA_DEV_TEST",
      "name": "VISA Dev Test",
      "image": [
        "phys_standard.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    }
  ]
}

Parameter	Type	Example	Description
cpds	object[]
id	int	4	ID
code	string	VISA_VIRT_2	CPD code
image	string[]	virtual.png	Image name array
segment	string[]	REATAIL	Marketing segment
status	string	NEW	CPD status
validFrom	string	"2023-05-29T00:00:00Z"	Beginning of CPD validity
validTo	string	"2030-05-29T00:00:00Z"	End of CPD validity

500 - Internal error

Status Code: 500 Internal error