Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R14.2.0

Excerpt

This method provides the ability to list the feedback of show a specific unit's jobs.feedback

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

unitfeedback_identifier

(mandatory)

Unit Feedback Identifier

The identifier of the unit, the jobs of which have been rated by Customers. The allowed unit feedback that should be retrieved. The allowed feedback identifier fields are the following:

Include Page
V4:unitfeedback_identifier
V4:unitfeedback_identifier

submitted_on_from

(optional)

Date The starting point for which the feedback was provided

submitted_on_to

(optional)

DateThe end point for which the feedback was provided

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

number_of_feedback_records

Number

The number of feedback records provided for the retrieved unit

average_ratingNumberThe average rating of the retrieved unit's feedback
job_feedback_setSet of Job All Scopes Feedback object

The individual feedback records provided for the retrieved unit's jobs

 

...

...

Response Data

Include Page
V4:job_all_scopes_feedbackfeedback_complete
V4:job_all_scopes_feedbackfeedback_complete

Examples

Expand
titleExample 1

HTTP Method:  POSTGET

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {{server}}/crmapi/rest/v2/feedback/show?token={{token}}&feedback_identifier=number=12

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "number": "12",
        "unit": {
            "alternative_code": "adminunit",
            "group_name": "Main Group",
            "community_name": "Community",
            "name": "Admin Unit",
            "description": "admin unit",
            "id": "1"
        },
        "comments": "Average",
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-09-11T18:26:24",
            "updated_date": "2018-09-11T18:26:25",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "test@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "test@crm.com",
                "username": "MPAdministrator"
            }
        },
        "feedback_classification": {
            "alternative_code": "CF",
            "name": "Customer Feedback",
            "description": "Customer Feedback - CF",
            "id": "24FA2699491D4BF68D54C1E8C0869962"
        },
        "rating": 7,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Papapavlou",
            "id": "E12B1552198540D7BDBBE5CCF23D0EE5",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Loukia",
            "title": "Miss",
            "type": "PERSON",
            "first_name": "Loukia",
            "demographics": {
                "id_number": "11225588",
                "gender": "FEMALE",
                "country_of_residence": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "date_of_birth": {
                    "month": 1,
                    "year": 1991,
                    "day": 28
                },
                "industry_sector": null,
                "industry": null,
                "name_day": {
                    "month": 12,
                    "day": 13
                },
                "passport_number_expiration_date": null,
                "id_number_expiration_date": null,
                "passport_number": null,
                "social_security_number": "99999999",
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "id": "AB43E9A2058E492DB525AECCE13AC960",
        "service_request": null,
        "performed_on": "2018-09-11T15:00:00",
        "type": "CUSTOMER",
        "job": {
            "number": "J00000734",
            "description": null,
            "rating_state": "COMPLETED",
            "accounts_receivable": {
                "number": "ACR0000000026",
                "name": "ACR0000000026 Loukia Papapavlou",
                "id": "ED512ED25BFF413280FA1BEB85DA9B1F",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "Papapavlou",
                    "id": "E12B1552198540D7BDBBE5CCF23D0EE5",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Loukia",
                    "title": "Miss",
                    "type": "PERSON",
                    "first_name": "Loukia",
                    "demographics": {
                        "id_number": "11225588",
                        "gender": "FEMALE",
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": 1,
                            "year": 1991,
                            "day": 28
                        },
                        "industry_sector": null,
                        "industry": null,
                        "name_day": {
                            "month": 12,
                            "day": 13
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": "99999999",
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "D62EDFA9A15F44E2A40EDEDB8CED0C23",
            "life_cycle_state": "COMPLETED",
            "type": {
                "billing_method": null,
                "alternative_code": "RPG",
                "name": "Replace Physical Goods on order",
                "fulfillment_scope": "REPLACE_PHYSICAL_GOODS",
                "description": null,
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "404D86E52AC44CEA8112696A91438904",
                "billing_directive": "BILLABLE"
            }
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}