How to return a Json object error on ASP.Net Core Restful Cotroller?

Question

I have a ASP.NET controller that controls a schedule (as I'm Brazilian, schedule in Portuguese means Agendamento).

The thing is, I can't allow scheduling the same room (in Portuguese Sala) being taken twice at the same time.

So in the POST request I check the DB to see if that room has already being taken and if it has I want to return only a Json object { "error": "You can't do that." }.

If the request does not have any problem then the insert should be done and the inserted object has to be returned.

[HttpPost]
public async Task<ActionResult<Agendamento>> PostAgendamento(Agendamento agendamento)
{

    var agendamentosJaExistentes = await _context.Agendamentos.Include(ag => ag.Sala)
        .Where(ag =>
                ag.SalaId == agendamento.SalaId &&
                (
                    (agendamento.PeriodoInicial >= ag.PeriodoInicial && agendamento.PeriodoInicial <= ag.PeriodoFinal)
                    ||
                    (agendamento.PeriodoFinal >= ag.PeriodoInicial && agendamento.PeriodoFinal <= ag.PeriodoFinal)
                    ))
        .ToListAsync();

    if (agendamentosJaExistentes != null)
    {
        return ??? JSON OBJECT ???
    }

    _context.Agendamentos.Add(agendamento);
    await _context.SaveChangesAsync();

    return CreatedAtAction("GetAgendamento", new { id = agendamento.Id }, agendamento);
}

Can you guys help me?

Michael Wang · Accepted Answer · 2020-07-03 02:41:45Z

Add NewtonsoftJson support

  public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers()
                .AddNewtonsoftJson();
    }

Return JsonObject

       if (agendamentosJaExistentes != null)
        {
            return new ObjectResult(Error("You can't do that.")); //???JSON OBJECT???
        }

400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

    public class ReturnJson
    {
        public string Status { get; set; }
        public string Message { get; set; }
    }

    public static ReturnJson Error(string responseMessage, string responseCode = "400")
        {
            ReturnJson returnJson = new ReturnJson()
            {
                Status = responseCode,
                Message = responseMessage ?? string.Empty
            };
            return returnJson;
        }

Test Result：

sidecus · Accepted Answer · 2020-07-03 01:26:39Z

0

For RESTful api one of the best practice is to return errors aligning with HTTP status code. For this specific case probably HTTP 500 (instead of 200 success with an error body) makes more sense.

You can do so by this:

    var result = new
    {
        Error = "Room already booked",
    };
    return this.StatusCode(StatusCodes.Status500InternalServerError, result);

answered Jul 3, 2020 at 1:26

sidecus

7625 silver badges10 bronze badges

Comments

Boutamen · Accepted Answer · 2020-07-07 19:17:07Z

0

This is a simple way that am using (DoteNet Core 3.x)

return Json(new { error = "Your error message " , status = 405 });

answered Jul 7, 2020 at 19:17

Boutamen

1191 silver badge4 bronze badges

Collectives™ on Stack Overflow

How to return a Json object error on ASP.Net Core Restful Cotroller?

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related