Detail of a relation between customers

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/{customer_id}/related-customers/{customer_relation_id}

Get information about a specific customer relation.

Responses

Response body

object

data

object

Basic information about a relation between customers.

customer_relation_id

string

The unique ID of the customer relation.

related_customer_id

string

required

The unique ID of the related customer.

short_name

string

Short name of the customer.

customer_relation_type_id

string

required

The unique ID of the customer relation type.

is_leading

boolean

required

Parameter says, if related customer is a leader in their relationship. Example: Parent is a leader, child is a follower

valid_from

string

Date and time when customer relation starts. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time when customer relation ends. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the related customer. Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/customers/customer_id/related-customers/customer_relation_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
13
 
1
{
2
  "data": {
3
    "customer_relation_id": "81eaeea13b8984a169c490a325",
4
    "related_customer_id": "8aa68a112c62ad5f84a22a0652",
5
    "short_name": "Peter D.",
6
    "customer_relation_type_id": "8bed991c68a470e7aaeffbf048",
7
    "is_leading": false,
8
    "valid_from": "2022-01-09 22:00:00",
9
    "valid_to": "2022-01-09 22:30:00",
10
    "last_change": "2022-06-23 11:47:22",
11
    "state": 1
12
  }
13
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.