Skip to main content
blog title image

3 minute read - API Testing API Challenges

Challenge 23 - How To - POST todos XML accept JSON

Jul 17, 2021

This post and video shows how to complete the challenge POST /todos XML to JSON to send a POST request to create a todo item using XML but receive JSON response.

What are the API Challenges?

Our API Challenges Application has a fully functional cloud hosted API, and a set of challenges to work through.

POST /todos XML to JSON

Issue a POST request on the /todos end point to create a todo using Content-Type application/xml but Accept application/json

  • POST request means we will send information in the body of the message
    • e.g. POST /todos sends to the todos endpoint
  • create a todo means that the payload will be valid data to create a todo item
  • using Content-Type application/xml means that we will set content-type header to application/xml and the payload will be in XML format
  • Accept application/json means add an accept header of application/json to receive the response in JSON format
  • add the X-CHALLENGER header to track progress

Basic Instructions

We can mix different accept and content-types so we can send payloads in one format, and receive responses in another format. This challenge is about sending payload in XML but having the response in JSON.

  • Issue a POST request to end point “/todos”
    • if running locally that endpoint would be
      • http://localhost:4567/todos
    • if running in the cloud that endpoint would be
      • https://apichallenges.herokuapp.com/todos
  • The request should have an Content-Type header of application/xml
  • add a valid payload in XML format to create a todo item e.g.
  <todo>
    <doneStatus>true</doneStatus>
    <title>file paperwork today</title>
  </todo>
  • add an accept header of application/json to receive the response in JSON format
  • The request should have an X-CHALLENGER header to track challenge completion
  • The response status code should be 201 when all the details are valid.
  • Check the body of the response has JSON formatted todo item with full details of the created item
  • Check the location header for the REST API call to retrieve details of the created item

Extras:

  • try GET the location header URL to return the created todo item

Details

> POST /todos HTTP/1.1
> Host: apichallenges.herokuapp.com
> User-Agent: insomnia/2021.2.2
> X-CHALLENGER: x-challenger-guid
> Content-Type: application/xml
> Accept: application/json
> Content-Length: 92

|   <todo>
|     <doneStatus>true</doneStatus>
|     <title>file paperwork today</title>
|   </todo>

< HTTP/1.1 201 Created
< Connection: close
< Date: Sat, 17 Jul 2021 14:37:49 GMT
< Content-Type: application/json
< Location: todos/278
< Access-Control-Allow-Origin: *
< Access-Control-Allow-Headers: *
< X-Challenger: x-challenger-guid
< Server: Jetty(9.4.z-SNAPSHOT)
< Via: 1.1 vegur

Example Response body:

{
  "id": 278,
  "title": "file paperwork today",
  "doneStatus": true,
  "description": ""
}

Overview Video

Patreon ad free version

Learn More and Start Testing