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 provide feedback for a specific job (upon its completion)

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

feedback_type

(mandatory)

String

The feedback's type. Available options are:

  • CUSTOMER

job_identifier

(semi-optional)

Job Identifier

The identifier of the job that the feedback will be provided for. The job must be in a completed Life Cycle State, and only one feedback can be provided per Job. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

service_request_identifier

(semi-optional)

Service Request Identifier

The identifier of the service request that the feedback will be provided for. The Service Request must be in a completed Life Cycle State, and only one feedback can be provided per Service Request. The allowed service

request

request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

unit_identifier

(semi-optional)

Unit Identifier

The identifier of the unit that the feedback will be provided for. If the job_identifier or the service_request_identifier are provided, then the unit is automatically provided as well. The allowed unit identifier fields are the following:

Include Page
V4:

service_request

unit_identifier
V4:

service

unit_

request_

identifier

Tip

Deprecated from CRM.COM R18.0.0


business_unit_identifier

(semi-optional)

Business Unit Identifier

The identifier of the business unit that the feedback will be provided for. If the job_identifier or the service_request_identifier are provided, then

the

the business unit is automatically provided as well. The

allowed

allowed business unit identifier fields are the following:

Include Page

V4:

business_unit_identifier

V4:

business_unit_identifier

Tip

Available from CRM.COM R18.0.0


feedback_classification_identifier

(mandatory)

Feedback Classification Identifier

The identifier of the feedback's classification. The allowed feedback classification fields are the following:

Include Page
V4:feedback_classification_identifier
V4:feedback_classification_identifier

rate

(mandatory)

NumberThe rate provided by the customer. The rating number should range between 0 and 10 (inclusive).

comments

(optional)

StringThe comments provided by the customer

contact_identifier

(mandatory)

Contact Information identifier

The contact that provided the feedback. The allowed contact identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

submitted_on

(mandatory)

Date The date that the feedback was submitted

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.

...

Expand
titleExample 1

HTTP Method: POST

Request:

Body:

Code Block
language
languagejavascript
themeConfluence
javascriptlinenumberstrue
 {
       "token":"{{token}}",
       "feedback_type" : "CUSTOMER",
       "job_identifier":{"number":"J00000734"},
       "contact_identifier":{"id_number":"11225588"},
       "feedback_classification_identifier":{"name":"Customer Feedback"},
       "submitted_on":"2018-09-11T15:00:00",
       "rate":7,
       "comments":"Average"
}

 


Response:

Code Block
languagejavascript
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": "Loukia Papapavlou",
            "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": "Loukia Papapavlou",
                    "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": ""
    }
}

 

...