How to return 'Error 404' from a Custom Service API

(0) Share

Report

Posted on by Hugo Alves

129

Hello Community,

i am developing an API on D365FO to expose data as Custom Service.
As i check no records were found, it should return a 404,
but a test ran from Postman receives a status 200 - ok

My returned JSON is ok, like below:

{
    "Company": "2",
    "InfologText": "Ciclo orçamentário 2022 não é válido.",
    "IntegEnvironment": 0,
    "Integration": 0,
    "ResultSet": []
}

Can anyone help how to change Response Status?

Thanks.

I have the same question (0)

All responses (6)

Answers (1)

Ludwig Reinhard Microsoft Employee on at

Like (0)

Report
Copy link

Link copied!

moved to the d365 forum

Was this reply helpful? Yes No
Martin Dráb 238,787 Most Valuable Professional on at

Like (0)

Report
Copy link

Link copied!

Why don't you simply throw an exception, if you consider that a failure?

Was this reply helpful? Yes No
Hugo Alves 129 on at

Like (0)

Report
Copy link

Link copied!

i've forced a Throw, but still i get Status 200 on Postman.

Was this reply helpful? Yes No
Martin Dráb 238,787 Most Valuable Professional on at

Like (0)

Report
Copy link

Link copied!

This doesn't look like an exception to me. It seems that your service successfully returned data (such as BudgetCycleName) - therefore it handled the exception and didn't throw any - and it merely included infolog messages in InfoText property. You may want to debug you service to see where the exception got handled.

It seems that somebody intentionally designed the service not to fail even if an exception occurs.

Was this reply helpful? Yes No
Hugo Alves 129 on at

Like (0)

Report
Copy link

Link copied!

First of all, thanks Martin,
but after these thoughts let me improve the question,
and let´s make it a relevant future reference to this subject...

Is it possible to either handle exceptions and also Change the Response Status to 404?
(lets say i want to have control on replied Response JSON, or any other feasiable scenario)

Or Throwing Error is recommended/possible approach to Reply Error on Custom Service?
and in this case we have no control on replied JSON.

Well, since i am not able to test Postman on DEV VM, it will take me some time to discover what error number the unhandled exception would return.

Was this reply helpful? Yes No
Verified answer

Martin Dráb 238,787 Most Valuable Professional on at

Like (0)

Report
Copy link

Link copied!

You can't define HTTP code of a custom service response by yourself. F&O give you only two options: success or failure (when you throw an exception).

Maybe you could use Azure API Management to analyze the response, drop it and return 404 instead.

By the way, consider creating another thread for your problem with Postman on DEV VM.

Was this reply helpful? Yes No