Efficy Overflow Q&A - Recent questions tagged json

Disable the chat access from Effcy's desktop

Mon, 28 Nov 2022 06:33:29 +0000

Hello,
We need to disable the chat access from Effcy's desktop.
Our clients don't need to contact Efficy support team.
It's urgent.

Thank you
Dimitri

(API) How to send fax and sms from Efficy as it exists for emails notifications ?

Thu, 10 Nov 2022 10:26:34 +0000

Hello,

Is there any API for sending sms and/or faxes from Efficy ?

Thank you
Dimitri

Is there a way to send mutlivalue fields values through the API ?

Wed, 05 Oct 2022 16:01:01 +0000

We try to use the API to call an Efficy Query that contains multivalue fields.

When we execute the query in Efficy, the result contains the value of the multivalue field, but when we execute the query through the API, the multivalue field is getting the key separated by semic-columns.

In order to test it in a standard Efficy 12.0 Efficy Entreprise, it is quite easy :

1- create an API key in Efficy Designer (link to admin user)
2- create an Efficy Query for instance :
[Select]
OPPORTUNITIES.K_OPPORTUNITY
OPPORTUNITIES.NAME
OPPORTUNITIES.COMPETITORS

[From]
OPPORTUNITIES

[Where]
OPPORTUNITIES.COMPETITORS notisnull ""

[Orderby]

[Options]
ChangeParameters=0
Distinct=0

[InlineEdit]

3- Call this query from Postman :

URL : http://{{YOUR_LOCAL_EFFICY}}/crm/json

HEADERS
X-Efficy-ApiKey:{{EfficyAPIKey}}
Cache-Control:no-cache
Content-Type:application/json
Accept:application/json
Cookie:{{EfficyCookie}}
X-Efficy-Logoff:False
X-Efficy-Lang:FR

BODY
[
{
"@name": "api",
"@func": [
{
"@name": "query",
"key": "{{Efficy Query KEY}}"
}
]
}
]

Result of the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": ";1;2;"
},

Result in Efficy :

Attended Result from the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": "Competitor1, Competitor2"
},

PS: I Tried with the Alias "MULTIVALUE" but that did not change a thing.

Read JSON column in Oracle

Thu, 04 Aug 2022 07:21:19 +0000

Hi,

does anyone know how to read a JSON value in Oracle. I need this to represent the value based on the value set in the JSON. But until now I'm not been able to read the JSON object with Oracle.

I hope someone can help me with this.

Best regards,
Jeroen

When inserting mail through JSON API, is it possible to fill MEMO with body of Mail

Wed, 03 Nov 2021 09:04:14 +0000

When inserting mail through JSON API, is it possible to fill MEMO with body of Mail just like the Outlook addin does this ?

Meaning : Is there a function in Efficy that does this or does the customer need to extract the body from the .eml file and then set the MEMO field in the normal (API) way ?

Alphanumeric field gives bizarre error in JSON API request

Thu, 14 Oct 2021 18:22:26 +0000

when executing the following request

[{
        "@name": "Edit",
        "entity": "Docu",
        "commit": "true",
        "closecontext": "true",
        "@func": [{
                "@name": "update",
                "@data": {
                    "NAME": "Klein testje 2021",
                    "F_DIENST": 6,
                    "F_TYPE": 70,
                    "F_ONTVANGSTWIJZE": 0,
                    "F_NR_AANGETEKEND": "220309282357",
                    "MEMOFORMATTED": 0,
                    "MEMO": "",
                    "F_STATUS": 0
                }
            }
        ]
    }
]

we get this error :

"#error": {
"errorcode": "EConvertError",
"errorstring": "'' is not a valid date and time"
}

The field F_NR_AANGETEKEND is the problem.
It's an alphanumeric field with a length of 32.

values like "" or "123" or "0" etc are no problem.
But values like this give the conversion error.
Is this a bug or is there another way how we can force the API to see the value as a string ?

This happens on a Efficy (Build 11.2.19857.0 2019-12-07 12:02)

is there a way to make difference between '' and null value in a dataset returned by an sqlQueryDataset

Mon, 10 May 2021 13:34:56 +0000

Hi all,

When using something like dataSetToJson(Efficy.sqlQueryDataset(MyQuery, "")) the result give me '' (empty value) for empty value fields, but also for null value fields.

i've an idea of workaround with a coalesce in the query, but ... is there a standard or a better way to get the "real" null value ?

Regards,

Config when using json/node api in loadbalencer environnement

Thu, 03 Dec 2020 08:48:55 +0000

Hi all,

For a customer, we will need to use json/api node.
Customer have actually an environnement with 2 "frontend" serveur behind a loadbalencer, and 1"webservice" serveur for soap call.

Should we use the same infrastrucure and make json/node api call to the webservice serveur to avoid session problem ?
Or is there something better to do ?

regards,

Is it possible to pass a null value in JSON API request?

Wed, 19 Aug 2020 06:23:17 +0000

To create a company I'm using the following JSON API request:

[
{
"@name": "edit",
"entity": "Comp",
"key": 0,
"commit": true,
"@func": [
{
"@name": "update", 
"@data": 
{
"NAME": "Test 01",
"VAT": null
}
}
]
}
]

but getting "Unknown data type for field VAT" error:

[
    {
        "@name": "edit",
        "entity": "Comp",
        "commit": true,
        "@func": [
            {
                "@name": "update",
                "@data": {
                    "NAME": "Test 01",
                    "VAT": null
                },
                "#error": {
                    "errorcode": "EEfficyException",
                    "errorstring": "Unknown data type for field \"VAT\"",
                    "detail": "CORE-1326"
                }
            }
        ],
        "key": "13",
        "edithandle": "2",
        "#error": true
    },
    {
        "@name": "exception",
        "#error": {
            "errorcode": "EEfficyException",
            "errorstring": "Unknown data type for field \"VAT\"",
            "detail": "CORE-1326"
        }
    }
]

Is it possible to pass a null value somehow?
Skipping the line will make the request to work, but sometimes it is necessary to pass a null (not an empty string, 0, etc)

JSON request with special characters

Tue, 02 Jun 2020 09:33:44 +0000

I have a problem when I send a request with JSON body containing special characters => The JSON is considered as malformed.
Visual Studio displays it correctly

But with Fiddler I see that a “é” is not well encoded, even if I specify the UTF-8 charset.

Is it possible to filter by null values using "consultmanyex" function (JSON API) ?

Mon, 02 Mar 2020 07:08:22 +0000

I'm using the JSON API to call the "consultmanyex" function and search for an entity that meet a certain predicate.

I would like to base my predicate on the existence of a value for a certain field.

Do you have an idea of how I can specify a "Null" value in my predicate ?

Here is a query example (that obviously does not work) of what I'm trying to achieve :

[{
    "@name": "api",
    "commit": true,
    "closecontext": true,
    "@func": [
        {
            "@name": "consultmanyex",
            "entity": "ContComp",
            "findfield": "k_contact;d_end",
            "keys": "3544;NULL",
            "separator": ";"
        }
    ]
}]

how to request via json api both a file name and it's contents by a key

Mon, 02 Mar 2020 07:08:17 +0000

When I use the following json to request an attachment to a document, the response contains the byte stream (base64 encoded), but not the name of the attachment, and not the mime type. In addition, I need to know the key of the document; only the key of the attachment is not sufficient.

[
{
"@name": "edit",
"entity": "Docu",
"key": 684362,
"closecontext": true,
"@func": [
{"@name": "attachment", "key": "888274_0"}
]
}
]

Preferably it would be possible to request the file name, mime type, and contents of an attachment only by it's key. Can this perhaps be accomplished by an array of requests?

Thanks in advance.

Remote API: Trouble linking a Case to a Document with JSON

Wed, 12 Feb 2020 12:39:13 +0000

Hi,

when I try to link a Case to a newly created Document I get the following error:

{
            "@name": "insertDetail",
            "detail": "Case",
            "detailKey": 31,
            "#error": {
                "errorcode": "EConvertError",
                "errorstring": "'' is not a valid floating point value"
            }
        }

I'm using the flowing to link the Case to the Document:

{
"@name": "insertDetail",
"detail": "Case",
"detailKey": 31
}

What could be the cause of this error?

PS. When I try to link in Efficy a Case to a Document I don't have any issues.

Best regards,
Jeroen

Insert an attachment through JSON?

Wed, 12 Feb 2020 09:19:07 +0000

Hi,

does anyone know how to insert an attachment through JSON?
I need this for a customer who wants to insert documents from a website.

Best regards,
Jeroen

How to use Remote Api when sso is activated

Mon, 14 Oct 2019 09:29:37 +0000

Hi All,

I have made an listle custom using /json and /node api.
Working good on the customer test server, but not in their prod server because sso is activated.

(receive a 401 access denied, exactly like you click cancel on the pop windows when trying to connect with a browser)

what do i need to do ?
sending "something" in the header of the request for sso ?
configuring "something" on the server to don't use sso for the remote api ?
other ?

Regards.

Download CONTACTS.PICTURE using api

Mon, 12 Aug 2019 13:24:51 +0000

Is it possible to download pictures from for example contacts.picture using a json API request? I cannot find any documentation about this.

API calls to a test environment reflects request body?

Tue, 26 Mar 2019 11:07:21 +0000

Hi,

I've been trying to use the json api on a test environment. Every time I send a request, it just reflects the json body I sent back to me instead of the data I request.

I use this url: {testenvironment}/crm/json

These are the request headers:

These are the response headers:

I have a feeling I'm missing something obvious.