Custom Service - How to return HTTP 400 Bad Request?

(0) Share

Report

Posted on by Raed Salah Bzour

Hi everyone,

I'm building a Custom Service in D365 F&O (X++) that is called from an external website. The service works fine, but I noticed that it always returns HTTP 200 OK regardless of the outcome — even when my business logic fails (e.g. record not found, etc.).

Currently I'm returning a custom response contract with a Success (boolean) and Message (string) field, and checking Success on the client side. This works but ideally I'd like to return proper HTTP status codes like 400 Bad Request for business validation failures.

Is there any way to control the HTTP response status code from within a D365 JSON Custom Service?

Thank you

Categories:

Dynamics 365 Finance

I have the same question (0)

All responses (6)

Answers (1)

Sort by

Suggested answer

Deepak Agarwal 8,728 on at

Like (1)

Report
Copy link

Link copied!

If you are using your custom service, you need to return error response when there is an error, not default success. Use this URL HTTP status codes to refer what code can be used in different error conditions.

Was this reply helpful? Yes No
Verified answer

Martin Dráb 239,444 Most Valuable Professional on at

Like (2)

Report
Copy link

Link copied!

I disagree that you get 200 when a custom service throws an unhandled exception. You get 500 in such a case, as far as I know. Are you sure that you threw an exception?

Anyway, you don't control the error codes returned by F&O; all you can do is letting the operation complete successfully or throw an exception. What you could do is putting something like Azure API Management in front of the custom service, checking the response (e.g. looking for a particular infolog message) and change the status code of the response.

Was this reply helpful? Yes No
Raed Salah Bzour 15 on at

Like (0)

Report
Copy link

Link copied!

Hi Deepak,
thank you for your response, I am pretty familiar with these status codes, what I wanted is to change the status code based on the response

Was this reply helpful? Yes No
Raed Salah Bzour 15 on at

Like (0)

Report
Copy link

Link copied!

Hi Martin,

Of course, it returns 500 server error when I throw an exception, However I want to control the return status code like when the record is empty to return 404 Not Found status code also 400 for bad request if the validation is not met

I was wondering if there any built-in approach to control the return status code

Thanks

Was this reply helpful? Yes No
Deepak Agarwal 8,728 on at

Like (1)

Report
Copy link

Link copied!

There is no built in approach in X++ to handle different status, you need to write custom code for that. I would suggest to identify all the use case and related status code and return them accordingly when different error occured. I used the same approach recently.

Was this reply helpful? Yes No
Raed Salah Bzour 15 on at

Like (0)

Report
Copy link

Link copied!

Hi Deepak,
I understand your point and I almost use the same approach by returning success and message, I can return the status code as well, but what I want it to have the full control on the response.

I will stick with Martin's solution using Azure API Management.

Was this reply helpful? Yes No