How to return an arbitrary json object from Asp.net WebApi RC?

Question

Before I had this code to return an arbitrary json object with just an id property. How do I convert this to the new RC version of WebApi now that HttpResponseMessage is not supported and it now uses Newtonsofts JSON.NET?

public HttpResponseMessage<JsonValue> Post(MyModel model)
{
            var id = _theService.AddEntity(model);
            dynamic okResponse = new JsonObject();
            okResponse["id"] = id;
            return new CreateResponse<JsonValue>(okResponse);
}

And...

public class CreateResponse<T> : ResponseBase<T>
    {
        public CreateResponse()
            : base(HttpStatusCode.Created)
        {
        }

        public CreateResponse(T resource)
            : base(resource, HttpStatusCode.Created)
        {
        }
    }

 public abstract class ResponseBase<T> : HttpResponseMessage<T>
    {
        protected ResponseBase(HttpStatusCode httpStatusCode)
            : base(httpStatusCode)
        {
        }

        protected ResponseBase(T resource, HttpStatusCode httpStatusCode)
            : base(resource, httpStatusCode)
        {


            if (resource is IApiResource)
            {
                var apiResource = resource as IApiResource;
                var resourceLocation = new ResourceLocation();
                apiResource.SetLocation(resourceLocation);
                Headers.Location = resourceLocation.Location;
            }
        }
    }

I'm not familiar with the RC version of WebApi, but can you show what you try with this new version, and why it is not working? — Tisho
– Tisho, Commented Jun 15, 2012 at 11:49
HttpResponseMessage<T> is no longer supported and instead of creating a response of type T and passing the content into the constructor, the response is created using an extension method off Request. Also, NetwonSoft's JSON.Net is used instead of the System.Json types. — jaffa
– jaffa, Commented Jun 15, 2012 at 13:05

Jon Lin · Accepted Answer · 2012-06-17 09:16:04Z

3

The CreateResponse extention method does not accept dynamic variables.

Please change

dynamic okResponse = new JsonObject();

to something like

var okResponse = new JsonObject();

Please see this link also: https://aspnetwebstack.codeplex.com/discussions/359242

edited Jun 17, 2012 at 9:16

Jon Lin

144k29 gold badges226 silver badges224 bronze badges

answered Jun 16, 2012 at 10:52

Bah

1111 bronze badge

Sign up to request clarification or add additional context in comments.

3 Comments

jaffa Over a year ago

Hi, tried this: var okResponse = new JsonObject(); okResponse["id"] = 101; return Request.CreateResponse(HttpStatusCode.Created, okResponse); but payload shows {"id":[]} ?

jaffa Over a year ago

I was using the System.Json instead of Newtonsoft's version. Thanks for answer.

Sachin Kumar Over a year ago

Hi jaffa, i am also getting the payload like: {"Id":[],"class":[],"address":{"street":[],"zip":[]}}. How you resolved? Can you please show me the code syntax using Newtonsoft's version ?

Alexander Zeitler · Accepted Answer · 2012-06-15 14:22:54Z

2

Use Request.CreateResponse(statuscode, content) inside your controller

answered Jun 15, 2012 at 14:22

Alexander Zeitler

13.2k14 gold badges92 silver badges144 bronze badges

5 Comments

jaffa Over a year ago

Ok thanks, but what is the type of 'content'? This gives me a compile error: dynamic okResponse = new JsonObject(); okResponse["id"] = checkResult.NewLeadId; return Request.CreateResponse(HttpStatusCode.Created, okResponse);

jaffa Over a year ago

Also how do you achieve this in ActionFilterAttribute::OnActionExecuting()? There is no CreateResponse extension on context.Request.? (This is a nightmare)

Filip W Over a year ago

Request.CreateResponse is not part of Web API RC. YOu'd need codeplex source or NuGet nightly builds for that.

jaffa Over a year ago

Request.CreateResponse IS part of Web API RC as I've just used it. The issue is how to do this in an ActionFilterAttribute. Still confused about the returning of Json from the CreateResponse() too.

Alexander Zeitler Over a year ago

content is typeof ObjectContent or just your entity instance

Jim Harte · Accepted Answer · 2012-06-16 01:11:50Z

0

Maybe I'm missing something in your question, but you could just do this:

public dynamic Post(MyModel model)
{
            var id = _theService.AddEntity(model);


            return new { id = id };
}

EDIT: assuming your client sets the Content-type to application/json

answered Jun 16, 2012 at 1:11

Jim Harte

2,6633 gold badges24 silver badges21 bronze badges

Collectives™ on Stack Overflow

How to return an arbitrary json object from Asp.net WebApi RC?

3 Answers 3

3 Comments

5 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

5 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related