Knowledge Base

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:

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

user object

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

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:

Postman collection