OData InvalidOperationException. Bad Request - Error in query syntax

Question

Working with ASP.NET Core and OData v4

I get a

InvalidOperationException: The path template 'Classes({key})/Bookings({bookingKey})' on the action 'GetBooking' in controller 'Classes' is not a valid OData path template. Bad Request - Error in query syntax.

I don't see the error in query syntax. Here is the full code of this method in my controller 'Classes'

    /// 
    /// Get a specific booking
    /// 
    /// 
    [HttpGet]
    [ODataRoute("Classes({key})/Bookings({bookingKey})")]
    public async Task GetBooking([FromODataUri] Guid key, [FromODataUri] Guid bookingKey)
    {
        var @class = await _context.Classes.FirstOrDefaultAsync(y => y.Id == key);

        if (@class == null)
        {
            return NotFound();
        }

        var booking = _context.Bookings.Where(y => y.Class.Id == key && y.Id == bookingKey);

        if (!booking.Any())
        {
            return NotFound();
        }

        return Ok(SingleResult.Create(booking));
    }

This method is defined in 'Classes' Controller. I also have a GeBookings method and 2 actions methods defined that cause no issue. When I comment my GetBooking() method I don't have any error.

Booking is a [Contained] ICollection of Booking

public class Class
{
    [Key]
    public Guid Id { get; set; }

    // Others properties

    [Contained]
    public ICollection Bookings {get; set;}
}

I really see my error. Were should I look?

EDIT More information

It seems my ICollection of Booking is not considered as a contained navigation property byt really like a collection

{
    "@odata.context": "https://localhost:44375/odata/$metadata#Classes",
    "value": [
        {
            "Id": "dde8de4d-89ca-4ba3-cff7-08d6aac63c0f",
            "Title": "xxx",
            "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "StartTime": "2019-02-24T18:00:00+08:00",
            "EndTime": "2019-02-24T19:00:00+08:00",
            "Status": "Draft",
            "Positions": 22,
            "Bookings": []
        }
    ]
}

Bastien Vandamme · Accepted Answer

Answer coming from xuzhg https://github.com/OData/WebApi/issues/1789

Bookings is configured as "Structural property" and its type is complex type. Complex type is structural type without key,therefore, your path template 'Classes({id})/Bookings({bookingId})' can't work.

The root cause is the call "registerAction.Returns()", this line will configure the "Booking" type as complex type. I think if you call "registerAction.ReturnsFromEntitySet("Bookings")" can resolve the problem. Thanks

OData InvalidOperationException. Bad Request - Error in query syntax

Answers (1)

Related Questions