POST service_requests/respond

This method is updating a service request's response information and sets the service request to life cycle state "Responded". A single service request can be responded by each call.

Available from CRM.COM R5.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

service_request_identifier

(mandatory)

Service Request identifier

The identifier of the service request that should be updated. The allowed service request identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request

number

(semi-optional)

String

The number of the service request

description

(optional)

String

A description of the service request that will be updated

notes

(optional)

String

Shared notes fir the service request

status_identifier

(mandatory)

Service Request Status Identifier

The status of the service request. The allowed service request status identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request status

name

(semi-optional)

String

The name of the service request status

alternative_code

(semi-optional)

String

The alternative code of the service request status

response

(mandatory)

Service Request Response Object

The response that will be provided for the specified service request

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

Referred Parameter Objects Data

service_request_response parameters object data

Name

Type

Description

category_identifier

(mandatory)

Response Category Identifier

The category of the provided response. The allowed response category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request response category

name

(semi-optional)

String

The name of the service request response category

code

(semi-optional)

String

The code of the service request response category

responded_by_identifier

(mandatory)

User Identifier

The user that provided the response. The allowed user identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

response_date

(mandatory)

Date

The date that the response was provided

description

(optional)

String

A description of the provided response

accepted_by_identifier

(optional)

Contact Information Identifier

The contact information that accepted the response on behalf of the customer. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

Available from CRM.COM R9.0.0

Restrictions

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

Response Data

service_request object response data

Name	Type	Description
id	String	The ID of the retrieved service request
number	String	The number of the retrieved service request
description	String	The description of the retrieved service request
life_cycle_state	String	The life cycle state of the retrieved service request which can be PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specified service request

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
    "token" : "{{token}}",
    "service_request_identifier" : { "number" : "SR00000275" },
    "status_identifier" : {   "name" : "Responded" },
    "response" :
        {
            "category_identifier" : { "name" : "SR Resp. Category"},
            "responded_by_identifier" : { "username" : "mpadministrator"  },
            "response_date" : "2016-07-18T12:58:39",
            "description" : "Response Description"
        }
}

Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Jobs",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Philippos",
        "type": "PERSON",
        "id": "39F2067A3A4A4AE886739E4643820B28",
        "name": "Philippos Jobs",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "2121",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR0000000198",
      "id": "732CE3E9D1C44A9486284DDEFF4743FA",
      "name": "ACR0000000198 Philippos Jobs"
    },
    "life_cycle_state": "RESPONDED",
    "number": "SR00000275",
    "id": "CFD293E0B3E84ACE8C44673A6515EE4A",
    "description": null
  }
}