Description

This endpoint must be used for updating a specific user by id ({id})

This endpoint must be consumed in PATCH request


Request


As part of the request headers, a Basic Auth must be sent:

Postman auth bearer token

This must be sended in the Http headers of the request, look at the next curl example for a better understanding

Copy codecurl --location --request PATCH 'host:port/zynchro.api.system-config/v1/users/3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ••••••' \
--data-raw '{
    "header": {
        "transactionId": "123456"
    },
    "data": {
        "user": {
            "name": "User Test Modif",
            "email": "user_test_modif@test.com",
            "password": "33556567",
            "telephone": "23232323232",
            "isControlTower": true
        },        
        "clientsProfile": [
            {
                "clientId": 33,
                "profileId": 1
            },
            {
                "clientId": 38,
                "profileId": 1
            }
        ]
    }
}'


In java it would be something like this (depending on the dependency you use)

Copy codeOkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"header\": {\r\n        \"transactionId\": \"123456\"\r\n    },\r\n    \"data\": {\r\n        \"user\": {\r\n            \"name\": \"User Test Modif\",\r\n            \"email\": \"user_test_modif@test.com\",\r\n            \"password\": \"33556567\",\r\n            \"telephone\": \"23232323232\",\r\n            \"isControlTower\": true\r\n        },        \r\n        \"clientsProfile\": [\r\n            {\r\n                \"clientId\": 33,\r\n                \"profileId\": 1\r\n            },\r\n            {\r\n                \"clientId\": 38,\r\n                \"profileId\": 1\r\n            }\r\n        ]\r\n    }\r\n}");
Request request = new Request.Builder()
  .url("host:port/zynchro.api.system-config/v1/users/3")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer ••••••")
  .build();
Response response = client.newCall(request).execute();


Next are listed the params required in the request

Field
SubField
Type
Description
IsRequired
header

object

Y

transactionId
text

A custom value to identify the data related to the request in the response (you can see the transactionId in the response header).

Example:

  • REQ000001
Note: This field is not related to the creation of a new campaign, must be used by the client app in order to identify the request/response (if that is useful), the same value can be sended in multiple request (it’s not validated that the same value was sended before)
N

Data

 

Object

The specific body data related to the request

Y


user

Object

The user to update

Look for the description of user Object below

Y

clientsProfile

Array

The list of profiles and clients that the user will have access to

Look for the description of clientsProfile Object below

Y


user object

Field
SubField
Type
Description
IsRequired
user






name

text

The name of the user

Y

email

text

The email of the user

Y

telephone

text

The telephone of the user

Y

lastLogin

text

The last login date of the user

Y

isControlTower

boolean

Indicates if the user has access to the control tower module

Y
clientsProfile object

Field
SubField
Type
Description
IsRequired
clientsProfile






clientId

int

The client id to aplly

Y

profileId

text

The profile id to apply

Y



Consuming Service


Example Request

Consuming service 

(PATCH) URL:HOST:PORT/zynchro.api.system-config/v1/users/1?transaction_id=12233445666

Request Body (JSON RAW):


Response


Response 200 OK

If the params present in the request are valid, then you will receive a response 200 "ok" message code look at the next example:

Copy code{
    "header": {
        "resultCode": "ok",
        "messageCode": "ok",
        "messageDescription": "request ok",
        "transactionId": "123456"
    },
    "data": {
        "success": true,
        "message": "",
        "user": {
            "id": 3,
            "name": "User Test Modif",
            "email": "user_test_modif@test.com",
            "telephone": "23232323232",
            "lastLogin": "06-22-2024 05:04:06 PM",
            "isControlTower": false
        }
    }
}


Description of the response data

Field
SubField
Type
Description

header

 

Object

Specific data related to the response

 

resultCode

text

The result code of the response, can be:

·         error -> if errors were found

·         ok -> if NO errors were found

 

messageCode

text

The message code related to the result code of the response, can be:

Example:

 

 

messageDescription

text

The description of the message code

Example:

·         request ok

·         Please check your params fields

 

transactionId

text

The transactionId specified in the request, if no transactionId was sended in the request then the transacionId in the response will be null

errors

 

Array

 This field is present if there are errors in the request

 

fieldName

text

The field with errors

 

fieldDesc

text

 The description of the error

Data

 

Array

The specific response data related to the request


success

boolean

Indicates if the request was successfully processed


message

text

When success equals to false this field is used to describe the "error"


user

Object

The user updated

Field
SubField
Type
Description
user





id

int

The identifier of the user


name

text

The name of the user


email

text

The email of the user


telephone

text

The telephone of the user


lastLogin

text

The last login date of the user


isControlTower

boolean

Indicates if the user has access to the control tower module


Response 400

If there are errors with the request, then you will receive a 400 message response BAD_REQUEST with the errors field present, like the following example:

Copy code{
    "header": {
        "resultCode": "error",
        "messageCode": "BAD_REQUEST",
        "messageDescription": "Please check your params fields",
        "transactionId": "123455566677788"
    },
    "errors": [
        {
            "fieldName": "name",
            "fieldDesc": "Field is required, and must be of type String "
        },
        {
            "fieldName": "password",
            "fieldDesc": "Field is required, and must be of type String "
        },
        {
            "fieldName": "telephone",
            "fieldDesc": "Field is required, and must be of type String "
        },
        {
            "fieldName": "clientsProfile",
            "fieldDesc": "Field is required, and must be of type Array "
        },
        {
            "fieldName": "email",
            "fieldDesc": "Field is required, and must be of type String "
        }
    ]
}



Response 401

If you dont send any token, then you will receive a error message of "unauthorized", look at the next example:

Copy code{
    "error": "unauthorized",
    "error_description": "Full authentication is required to access this resource"
}


If you send a Token, but the Token you are sending is expired, then you will receive a response message with an "invalid_token" error, look at the next example:

Copy code{
    "error": "invalid_token",
    "error_description": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDM2MTk5NzMsInVzZXJfbmFtZSI6ImFsZWphbmRyby56YW5hYnJpYUBkaWdpd29ya3MuY29tLm14IiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9TWVNURU1BRE1JTiJdLCJqdGkiOiJHTGtQb3hQbVRTZUs2RFhmc1NfNkUxRkMxZmsiLCJjbGllbnRfaWQiOiJ6eW5jaHJvIiwic2NvcGUiOlsicmVhZCIsIndyaXRlIl19.yAFbdU18wMtQXSGUY3_noQn4BQv0RqYjDbw0sr1x6Yk"
}


This is the data retrieved when the 401 Unauthorized is retrieved:

Field
SubField
Type
Description

error

 

text

The type of the error, can be:

  • unauthorized
  • invalid_token


error_description


text

The description of the error, for the "invalid_token", this field retrieves the bearer token you're sending


Postman collection

File: