Classification group

Last modified by Daniel Oppitz on 24.02.2021, 17:22

Endpoints

/classifications/{classificationId}/groups

Get classification groups by classification id

Parameters:

  • Mandatory
    • classificationId
  • Optional
    • languageId
    • page
    • pageSize

Example response

https://example.eu.prodexa.com/pimapi/v1/classifications/prodexaDemo/groups?page=0&pageSize=20

{
   "status": 200,
   "meta": {
       "languageId": null,
       "paging": {
           "per_page": 20,
           "sorting": "OrderNo: ASC",
           "links": {
               "next": "https://example.eu.prodexa.com/pxm/pimapi/v1/classifications/prodexaDemo/groups/pageSize=20&page=0",
               "last": "https://example.eu.prodexa.com/pxm/pimapi/v1/classifications/prodexaDemo/groups/pageSize=20&page=0",
               "prev": "https://example.eu.prodexa.com/pxm/pimapi/v1/classifications/prodexaDemo/groups/pageSize=20&page=0",
               "self": "https://example.eu.prodexa.com/pxm/pimapi/v1/classifications/prodexaDemo/groups/pageSize=20&page=0",
               "first": "https://example.eu.prodexa.com/pxm/pimapi/v1/classifications/prodexaDemo/groups/pageSize=20&page=0"
            },
           "page": 0,
           "total_pages": 1,
           "total_items": 5
        },
       "contentType": "application/json"
    },
   "data": [
        {
           "classificationGroupId": "Computer",
           "hierarchyCode": "009000",
           "concatenatedInformation": null,
           "fallbackDescShort": "Computer",
           "documentUrl1": "",
           "documentUrl2": "",
           "documentUrl3": "",
           "orderNo": 0,
           "statusID": "400",
           "longDescriptions": [
                {
                   "languageId": "de-DE",
                   "value": "Computer"
                },
                {
                   "languageId": "en-GB",
                   "value": "Computer"
                }
            ],
           "createdOn": "2020-12-08T00:02:54.000+00:00",
           "createdBy": "prodexa",
           "changedOn": "2020-12-08T00:09:09.000+00:00",
           "changedBy": "prodexa"
        }
    ]
}

/classifications/{classificationId}/groups/{groupId}

Get all classification groups and subgroups by classification id and group id

Parameters:

  • Mandatory
    • classificationId
    • groupId
  • Optional
    • languageId
    • levels

Example response

https://example.eu.prodexa.com/pimapi/v1/classifications/eClass_5.1.3/groups/19000000?levels=0

{
   "status": 200,
   "meta": {
       "languageId": null,
       "contentType": "application/json"
    },
   "data": [
        {
           "classificationGroupId": "19000000",
           "hierarchyCode": "002000",
           "concatenatedInformation": null,
           "fallbackDescShort": "Information, communication and media technology",
           "documentUrl1": "",
           "documentUrl2": "",
           "documentUrl3": "",
           "orderNo": 0,
           "statusID": "400",
           "longDescriptions": [
                {
                   "languageId": "de-DE",
                   "value": "Information, communication and media technology"
                },
                {
                   "languageId": "en-GB",
                   "value": "Information, communication and media technology"
                }
            ],
           "createdOn": "2020-12-01T10:55:05.000+00:00",
           "createdBy": "prodexa",
           "changedOn": "2020-12-02T00:03:46.000+00:00",
           "changedBy": "prodexa"
        },
        {
           "classificationGroupId": "19010000",
           "hierarchyCode": "002000001",
           "concatenatedInformation": null,
           "fallbackDescShort": "Hardware",
           "documentUrl1": "documents/ITlogo.jpg",
           "documentUrl2": "",
           "documentUrl3": "",
           "orderNo": 0,
           "statusID": "400",
           "longDescriptions": [
                {
                   "languageId": "de-DE",
                   "value": "Hardware"
                },
                {
                   "languageId": "en-GB",
                   "value": "Hardware"
                }
            ],
           "createdOn": "2020-12-01T10:55:05.000+00:00",
           "createdBy": "prodexa",
           "changedOn": "2020-12-02T00:03:46.000+00:00",
           "changedBy": "prodexa"
        }
    ]
}
Tags: