Hey, this is my first web service. I have been reading about them to gain some knowledge. Went through a few samples of web services. I'm trying to create a RESTful web service to retrieve values from a http post from a different site. The user from
the different site knows I will be getting these values from his http post. So I want to create a RESTful web service to achieve this. Any info is appreciated.
I'm trying to create a RESTful web service to retrieve values from a http post from a different site. The user from the different site knows I will be getting these values from his http post.
Can the service be used in another website ? so that the user POST the data to your service? Is this is what above description?
To order to retreive data the HTTP verb that is used in RESTFul is GET , POST is used to create a new resource/record.
ASP.NET Web API is simple and light weight framework to build RESTFul service.
Implement the service as explained in above reference, provide the service URI to the user to post data. Note that you need to implement POST method to create/store the data.
Correct. I will be supplying the user of a vendor site the url.....so the user will POST the data to my service.
I understand that I would use GET. I have went through the Tutorial you supplied and have it working but not sure how I would call the data from the Users POST since the tutorial already supplies the data. Now once I have the data, I need to display the
data back to the user to conirm successful transmission of data. So I think I am close but trying to test this out on my end to confirm it is working.
Service will implement the POST method, which is consumed by the client to create a record. After successful creating of record using POST method your service returns HTTP status code 200. Being said that it is always feasible to return a confirmation message
or similar as you wish. But the standard practice is reutning HTTP status code (please refer below copied article snippet).
class to create a new product. Here is a simple implementation of the method:
// Not the final implementation! publicProductPostProduct(Product item) { item = repository.Add(item); return item; }
Note two things about this method:
The method name starts with "Post...". To create a new product, the client sends an HTTP POST request.
The method takes a parameter of type Product. In Web API, parameters with complex types are deserialized from the request body. Therefore, we expect the client to send a serialized representation of a product object, in either XML or JSON format.
This implementation will work, but it is not quite complete. Ideally, we would like the HTTP response to include the following:
Response code: By default, the Web API framework sets the response status code to 200 (OK). But according to the HTTP/1.1 protocol, when a POST request results in the creation of a resource, the server should reply with status 201 (Created).
Location: When the server creates a resource, it should include the URI of the new resource in the Location header of the response.
ASP.NET Web API makes it easy to manipulate the HTTP response message. Here is the improved implementation:
publicHttpResponseMessagePostProduct(Product item) { item = repository.Add(item); var response =Request.CreateResponse<Product>(HttpStatusCode.Created, item);
string uri =Url.Link("DefaultApi",new{ id = item.Id}); response.Headers.Location=newUri(uri); return response;
The tutorial nor the videos assisted me with the test I want to do. I want to test...me posting data from a separate application to the web service. Then the web service displaying the data back. I have went through the Products tutorials....which worked.
So I then added my own information and files for a web service to get data. I don't want to provide the data within the web service which is what the products tutorial is doing. I have been trying to get this work work by changing the url to have
http://localhost:xxxx/api/MyValues but won't work. Even trying the default...it still renders the products page after I removed all of the products files and cleared the cache.
me posting data from a separate application to the web service.
Testing POST method in web browser is same as providing the service URI to the user to use in web site, assuming that it is itnernal (no security implications).
Jon11sin
Then the web service displaying the data back.
This is demonstrated in the article referred in earlier response. check the below it returns the response after successful
creation of the product.
//ASP.NET Web API makes it easy to manipulate the HTTP response message. Here is the improved implementation:
public HttpResponseMessage PostProduct(Product item)
{
item = repository.Add(item);
var response = Request.CreateResponse<Product>(HttpStatusCode.Created, item);
string uri = Url.Link("DefaultApi", new { id = item.Id });
response.Headers.Location = new Uri(uri);
return response;
}
Jon11sin
I don't want to provide the data within the web service which is what the products tutorial is doing.
Yes, separation of concern by removing DAL (Data access layer) from the service. Move DAL into another class library project, add reference in Web API project.
Jon11sin
I have been trying to get this work work by changing the url to have
http://localhost:xxxx/api/MyValues but won't work. Even trying the default...it still renders the products page after I removed all of the products files and cleared the cache.
Post current implementation for further suggestion.
I haven't been able to find anything explaining the process of TESTING POST method as if I had a separate application running the service URI. Since how else i would test the web service the same way me giving it to a user. Sorry that I'm not getting
that part. Seems very straightforward but I was assuming it was a regular web form post of files but it appears its not.
Jon11sin
Member
184 Points
166 Posts
Get http posted values from a different site using RESTful Web Service
Feb 27, 2013 05:45 PM|LINK
Hey, this is my first web service. I have been reading about them to gain some knowledge. Went through a few samples of web services. I'm trying to create a RESTful web service to retrieve values from a http post from a different site. The user from the different site knows I will be getting these values from his http post. So I want to create a RESTful web service to achieve this. Any info is appreciated.
sukumarraju
All-Star
17349 Points
3058 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 12:25 AM|LINK
Can the service be used in another website ? so that the user POST the data to your service? Is this is what above description?
To order to retreive data the HTTP verb that is used in RESTFul is GET , POST is used to create a new resource/record.
ASP.NET Web API is simple and light weight framework to build RESTFul service.
Refer http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations
Implement the service as explained in above reference, provide the service URI to the user to post data. Note that you need to implement POST method to create/store the data.
Application Architecture Guide 2.0
My Blog
Twitter
Jon11sin
Member
184 Points
166 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 03:20 PM|LINK
Correct. I will be supplying the user of a vendor site the url.....so the user will POST the data to my service.
I understand that I would use GET. I have went through the Tutorial you supplied and have it working but not sure how I would call the data from the Users POST since the tutorial already supplies the data. Now once I have the data, I need to display the data back to the user to conirm successful transmission of data. So I think I am close but trying to test this out on my end to confirm it is working.
sukumarraju
All-Star
17349 Points
3058 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 03:38 PM|LINK
Service will implement the POST method, which is consumed by the client to create a record. After successful creating of record using POST method your service returns HTTP status code 200. Being said that it is always feasible to return a confirmation message or similar as you wish. But the standard practice is reutning HTTP status code (please refer below copied article snippet).
In order to read recently created record using POST method by the client, you can implement a GET method that returns a single record. Refer http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations
Let me know further help.
copied from the Web API tutorial article
Creating a Resource
Next, we'll add a method to the
class to create a new product. Here is a simple implementation of the method:Note two things about this method:
This implementation will work, but it is not quite complete. Ideally, we would like the HTTP response to include the following:
ASP.NET Web API makes it easy to manipulate the HTTP response message. Here is the improved implementation:
Application Architecture Guide 2.0
My Blog
Twitter
Jon11sin
Member
184 Points
166 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 06:45 PM|LINK
Ok. I'm almost there. So how would I check to make sure my code works.
sukumarraju
All-Star
17349 Points
3058 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 07:29 PM|LINK
Read the section 'Calling the Web API from the Browser' at http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api
Video tutorials
http://www.asp.net/web-api/videos
Application Architecture Guide 2.0
My Blog
Twitter
Jon11sin
Member
184 Points
166 Posts
Re: Get http posted values from a different site using RESTful Web Service
Feb 28, 2013 09:20 PM|LINK
The tutorial nor the videos assisted me with the test I want to do. I want to test...me posting data from a separate application to the web service. Then the web service displaying the data back. I have went through the Products tutorials....which worked. So I then added my own information and files for a web service to get data. I don't want to provide the data within the web service which is what the products tutorial is doing. I have been trying to get this work work by changing the url to have http://localhost:xxxx/api/MyValues but won't work. Even trying the default...it still renders the products page after I removed all of the products files and cleared the cache.
sukumarraju
All-Star
17349 Points
3058 Posts
Re: Get http posted values from a different site using RESTful Web Service
Mar 01, 2013 10:13 AM|LINK
Testing POST method in web browser is same as providing the service URI to the user to use in web site, assuming that it is itnernal (no security implications).
This is demonstrated in the article referred in earlier response. check the below it returns the response after successful creation of the product.
//ASP.NET Web API makes it easy to manipulate the HTTP response message. Here is the improved implementation: public HttpResponseMessage PostProduct(Product item) { item = repository.Add(item); var response = Request.CreateResponse<Product>(HttpStatusCode.Created, item); string uri = Url.Link("DefaultApi", new { id = item.Id }); response.Headers.Location = new Uri(uri); return response; }Yes, separation of concern by removing DAL (Data access layer) from the service. Move DAL into another class library project, add reference in Web API project.
Post current implementation for further suggestion.
Web API sample can be downloaded at http://www.asp.net/web-api/samples , first one is the Product solution.
Application Architecture Guide 2.0
My Blog
Twitter
Jon11sin
Member
184 Points
166 Posts
Re: Get http posted values from a different site using RESTful Web Service
Mar 01, 2013 06:48 PM|LINK
I haven't been able to find anything explaining the process of TESTING POST method as if I had a separate application running the service URI. Since how else i would test the web service the same way me giving it to a user. Sorry that I'm not getting that part. Seems very straightforward but I was assuming it was a regular web form post of files but it appears its not.
sukumarraju
All-Star
17349 Points
3058 Posts
Re: Get http posted values from a different site using RESTful Web Service
Mar 04, 2013 10:11 AM|LINK
Filler is open source tool to test the same.
Please refer http://www.codersphere.com/sean-mcalinden/blog/Testing-ASPNet-Web-API-using-fiddlers-composer to test your service using Fiddler.
Note that this tutorial walks through testing the Web API (service) on client side using HttpClient and other classes.
Application Architecture Guide 2.0
My Blog
Twitter