Skip to content

Apiary.io Blueprint Doc

Jump to bottom Edit New page
lukestokes edited this page Sep 25, 2014 · 3 revisions

FORMAT: 1A

RestFest2014 Todo

Todo API for Hack Day at Rest Fest 2014

Group Home

Root page for API

Home [/]

user-signup [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/",
              "method": "GET",
              "title": "Home"
          },
          "userCreate": {
              "href": "/users",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Signup Form",
              "data": {
                  "userName": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "userPassword": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "givenName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "familyName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "avatarUrl": {
                      "minlength": 4,
                      "maxlength": 200,
                      "type": "string",
                      "required": false
                  }
              }
          }
      },
      "message": "Welcome to the RESTFest 2014 TODO List App! Please create a user."
  }

Group Users

All resources related to users

Users [/users]

Users Resource

userList [GET]

  • Response 201 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "title": "This Collection"
          },
          "first": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Last Page of this Collection"
          },
          "categoryCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          }
      },
      "_embedded": {
          "users": [
              {
                  "_links": {
                      "self": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "GET"
                      },
                      "todoList": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
                          "method": "GET"
                      },
                      "completedTodoList": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/completedTodos",
                          "method": "GET"
                      },
                      "incompleteTodoList": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/incompleteTodos",
                          "method": "GET"
                      },
                      "todoCreate": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Create Todo",
                          "data": {
                              "todoTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              },
                              "todoDateDue": {
                                  "type": "date",
                                  "required": false
                              },
                              "todoNotes": {
                                  "minlength": 4,
                                  "maxlength": 10000,
                                  "type": "string",
                                  "required": false
                              }
                          }
                      },
                      "categoryList": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
                          "method": "GET"
                      },
                      "categoryCreate": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Create A Category",
                          "data": {
                              "categoryTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "userEdit": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit User",
                          "data": {
                              "userName": {
                                  "minlength": 4,
                                  "maxlength": 30,
                                  "type": "string",
                                  "required": true
                              },
                              "userPassword": {
                                  "minlength": 4,
                                  "maxlength": 30,
                                  "type": "string",
                                  "required": true
                              },
                              "givenName": {
                                  "minlength": 4,
                                  "maxlength": 100,
                                  "type": "string",
                                  "required": false
                              },
                              "familyName": {
                                  "minlength": 4,
                                  "maxlength": 100,
                                  "type": "string",
                                  "required": false
                              },
                              "avatarUrl": {
                                  "minlength": 4,
                                  "maxlength": 200,
                                  "type": "string",
                                  "required": false
                              }
                          }
                      },
                      "userDelete": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "DELETE",
                          "title": "Delete User"
                      }
                  },
                  "userid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
                  "userName": "john.doe",
                  "giveName": "John",
                  "familyName": "Doe",
                  "avatarUrl": "http://example.com/avatar.jpg",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

userCreate [POST]

  • Request Create a User (application/json)

      {
      "userName": "john.doe",
      "userPassword": "sfljwoenadsfonsaof",
      "giveName": "John",
      "familyName": "Doe",
      "avatarUrl": "http://example.com/avatar.jpg"
  }

  • Response 201 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "GET"
          },
          "completedTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/completedTodos",
              "method": "GET"
          },
          "incompleteTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/incompleteTodos",
              "method": "GET"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "categoryList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "GET"
          },
          "categoryCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "userEdit": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit User",
              "data": {
                  "userName": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "userPassword": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "givenName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "familyName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "avatarUrl": {
                      "minlength": 4,
                      "maxlength": 200,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "userDelete": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "DELETE",
              "title": "Delete User"
          }
      },
      "userid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "userName": "john.doe",
      "giveName": "John",
      "familyName": "Doe",
      "avatarUrl": "http://example.com/avatar.jpg",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

User [/users/{userid}]

A user page

  • Parameters
    • userid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The globally unique userid of the user

userRead [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "GET"
          },
          "completedTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/completedTodos",
              "method": "GET"
          },
          "incompleteTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/incompleteTodos",
              "method": "GET"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "categoryList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "GET"
          },
          "categoryCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "userEdit": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit User",
              "data": {
                  "userName": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "userPassword": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "givenName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "familyName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "avatarUrl": {
                      "minlength": 4,
                      "maxlength": 200,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "userDelete": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "DELETE",
              "title": "Delete User"
          }
      },
      "userid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "userName": "john.doe",
      "giveName": "John",
      "familyName": "Doe",
      "avatarUrl": "http://example.com/avatar.jpg",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

userEdit [PUT]

  • Request Update a User (application/json)

      {
      "giveName": "Jane",
      "userPassword": "asdjfalskfjlkasjfd",
      "familyName": "Doe",
      "avatarUrl": "http://example.com/avatar.jpg"
  }

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "GET"
          },
          "completedTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/completedTodos",
              "method": "GET"
          },
          "incompleteTodoList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/incompleteTodos",
              "method": "GET"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "categoryList": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "GET"
          },
          "categoryCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },                
          "userEdit": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit User",
              "data": {
                  "userName": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "userPassword": {
                      "minlength": 4,
                      "maxlength": 30,
                      "type": "string",
                      "required": true
                  },
                  "givenName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "familyName": {
                      "minlength": 4,
                      "maxlength": 100,
                      "type": "string",
                      "required": false
                  },
                  "avatarUrl": {
                      "minlength": 4,
                      "maxlength": 200,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "userDelete": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "DELETE",
              "title": "Delete User"
          }
      },
      "userid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "userName": "john.doe",
      "giveName": "John",
      "familyName": "Doe",
      "avatarUrl": "http://example.com/avatar.jpg",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

userDelete [DELETE]

  • Response 204

Group Todos

Categories [/users/{userid}/categories]

A list of categories

  • Parameters
    • userid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The globally unique userid of the user

categoryList [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "title": "This Collection"
          },
          "first": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories?offset=0",
              "title": "Last Page of this Collection"
          },
          "categoryCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          }
      },
      "_embedded": {
          "categories": [
              {
                  "_links": {
                      "self": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "GET"
                      },
                      "categoryRead": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "GET"
                      },
                      "todoList": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30/todos",
                          "method": "GET"
                      },
                      "categoryEdit": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Category",
                          "data": {
                              "categoryTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "categoryDelete": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "DELETE",
                          "title": "Delete Category"
                      }
                  },
                  "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
                  "title": "A1 Priority",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

categoryCreate [POST]

  • Request 201 (application/application+json)

      {
      "title": "A1 Priority"
  }

  • Response 201 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "GET"
          },
          "todoList": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30/todos",
              "method": "GET"
          },
          "categoryEdit": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryDelete": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "DELETE",
              "title": "Delete Category"
          }
      },
      "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "title": "A1 Priority",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

Category [/categories/{categoryid}]

A category for todos

  • Parameters
    • categoryid (required, string, ec210ff9-7b29-4784-82b2-7b4958618c30) ... The unique categoryid of the category

categoryRead [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "GET"
          },
          "userRead": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoList": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30/todos",
              "method": "GET"
          },
          "categoryEdit": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryDelete": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "DELETE",
              "title": "Delete Category"
          }
      },
      "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "title": "A1 Priority",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

categoryEdit [PUT]

  • Request 201 (application/application+json)

      {
      "title": "A1 Priority"
  }

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "GET"
          },
          "userRead": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoList": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30/todos",
              "method": "GET"
          },
          "categoryEdit": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Category",
              "data": {
                  "categoryTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryDelete": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "DELETE",
              "title": "Delete Category"
          }
      },
      "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "title": "A1 Priority",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

categoryDelete [DELETE]

  • Response 204

Todos [/users/{userid}/todos]

A list of todos for a user

  • Parameters
    • userid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The globally unique userid of the user

todoList [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "title": "This Collection"
          },
          "first": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Last Page of this Collection"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          }
      },
      "_embedded": {
          "todos": [
              {
                  "_links": {
                      "self": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "GET"
                      },
                      "userRead": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "GET"
                      },
                      "todoEdit": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo",
                          "data": {
                              "todoTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              },
                              "todoDateDue": {
                                  "type": "date",
                                  "required": false
                              },
                              "todoNotes": {
                                  "minlength": 4,
                                  "maxlength": 10000,
                                  "type": "string",
                                  "required": false
                              }
                          }
                      },
                      "todoDelete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "DELETE",
                          "title": "Delete Todo"
                      },
                      "todoComplete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/complete",
                          "method": "PUT",
                          "title": "Complete Todo"
                      },
                      "todoIncomplete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/incomplete",
                          "method": "PUT",
                          "title": "Incomplete Todo"
                      },
                      "todoSend": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Complete Todo",
                          "data": {
                              "userid": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "todoEditDateDue": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo Date Due",
                          "data": {
                              "todoDateDue": {
                                  "type": "date",
                                  "required": true
                              }
                          }
                      },
                      "todoCategoryCreate": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Add Category to Todo",
                          "data": {
                              "categoryid": {
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "todoCategoryList": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "GET"
                      }
                  },
                  "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
                  "todoTitle": "Make Money",
                  "todoNotes": "If we're not making money, it's a hobby.",
                  "todoDateDue": "2014-11-03 14:22:18",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

todoCreate [POST]

  • Request Create a User (application/json)

      {
      "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
      "todoTitle": "Make Money",
      "todoNotes": "If we're not making money, it's a hobby.",
      "todoDateDue": "2014-11-03 14:22:18"
  }

  • Response 201 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "GET"
          },
          "userRead": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoEdit": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "todoDelete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "DELETE",
              "title": "Delete Todo"
          },
          "todoComplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/complete",
              "method": "PUT",
              "title": "Complete Todo"
          },
          "todoIncomplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/incomplete",
              "method": "PUT",
              "title": "Incomplete Todo"
          },
          "todoSend": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Complete Todo",
              "data": {
                  "userid": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "todoEditDateDue": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo Date Due",
              "data": {
                  "todoDateDue": {
                      "type": "date",
                      "required": true
                  }
              }
          },
          "todoCategoryCreate": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Add Category to Todo",
              "data": {
                  "categoryid": {
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryList": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "GET"
          }
      },
      "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
      "todoTitle": "Make Money",
      "todoNotes": "If we're not making money, it's a hobby.",
      "todoDateDue": "2014-11-03 14:22:18",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

Completed Todos [/users/{userid}/completedTodos]

A list of todos for a user

  • Parameters
    • userid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The globally unique userid of the user

completedTodoList [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "title": "This Collection"
          },
          "first": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Last Page of this Collection"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          }
      },
      "_embedded": {
          "todos": [
              {
                  "_links": {
                      "self": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "GET"
                      },
                      "userRead": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "GET"
                      },
                      "todoEdit": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo",
                          "data": {
                              "todoTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              },
                              "todoDateDue": {
                                  "type": "date",
                                  "required": false
                              },
                              "todoNotes": {
                                  "minlength": 4,
                                  "maxlength": 10000,
                                  "type": "string",
                                  "required": false
                              }
                          }
                      },
                      "todoDelete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "DELETE",
                          "title": "Delete Todo"
                      },
                      "todoIncomplete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/incomplete",
                          "method": "PUT",
                          "title": "Incomplete Todo"
                      },
                      "todoSend": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Complete Todo",
                          "data": {
                              "userid": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "todoEditDateDue": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo Date Due",
                          "data": {
                              "todoDateDue": {
                                  "type": "date",
                                  "required": true
                              }
                          }
                      },
                      "todoCategoryCreate": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Add Category to Todo",
                          "data": {
                              "categoryid": {
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "categoryList": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "GET"
                      }
                  },
                  "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
                  "todoTitle": "Make Money",
                  "todoNotes": "If we're not making money, it's a hobby.",
                  "todoDateDue": "2014-11-03 14:22:18",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

Incomplete Todos [/users/{userid}/incompleteTodos]

A list of todos for a user

  • Parameters
    • userid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The globally unique userid of the user

incompleteTodoList [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "title": "This Collection"
          },
          "first": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos?offset=0",
              "title": "Last Page of this Collection"
          },
          "todoCreate": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1/todos",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          }
      },
      "_embedded": {
          "todos": [
              {
                  "_links": {
                      "self": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "GET"
                      },
                      "userRead": {
                          "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
                          "method": "GET"
                      },
                      "todoEdit": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo",
                          "data": {
                              "todoTitle": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              },
                              "todoDateDue": {
                                  "type": "date",
                                  "required": false
                              },
                              "todoNotes": {
                                  "minlength": 4,
                                  "maxlength": 10000,
                                  "type": "string",
                                  "required": false
                              }
                          }
                      },
                      "todoDelete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
                          "method": "DELETE",
                          "title": "Delete Todo"
                      },
                      "todoComplete": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/complete",
                          "method": "PUT",
                          "title": "Complete Todo"
                      },
                      "todoSend": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Complete Todo",
                          "data": {
                              "userid": {
                                  "minlength": 4,
                                  "maxlength": 50,
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "todoEditDateDue": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
                          "method": "PUT",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Edit Todo Date Due",
                          "data": {
                              "todoDateDue": {
                                  "type": "date",
                                  "required": true
                              }
                          }
                      },
                      "todoCategoryCreate": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "POST",
                          "request_encoding": "application/x-www-form-urlencoded",
                          "title": "Add Category to Todo",
                          "data": {
                              "categoryid": {
                                  "type": "string",
                                  "required": true
                              }
                          }
                      },
                      "categoryList": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
                          "method": "GET"
                      }
                  },
                  "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
                  "todoTitle": "Make Money",
                  "todoNotes": "If we're not making money, it's a hobby.",
                  "todoDateDue": "2014-11-03 14:22:18",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

Todo [/todos/{todoid}]

A Todo Item

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoRead [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "GET"
          },
          "userRead": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoEdit": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "todoDelete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "DELETE",
              "title": "Delete Todo"
          },
          "todoComplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/complete",
              "method": "PUT",
              "title": "Complete Todo"
          },
          "todoIncomplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/incomplete",
              "method": "PUT",
              "title": "Incomplete Todo"
          },
          "todoSend": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Complete Todo",
              "data": {
                  "userid": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "todoEditDateDue": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo Date Due",
              "data": {
                  "todoDateDue": {
                      "type": "date",
                      "required": true
                  }
              }
          },
          "todoCategoryCreate": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Add Category to Todo",
              "data": {
                  "categoryid": {
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryList": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "GET"
          }
      },
      "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
      "todoTitle": "Make Money",
      "todoNotes": "If we're not making money, it's a hobby.",
      "todoDateDue": "2014-11-03 14:22:18",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

todoEdit [PUT]

  • Request Update a User (application/json)

      {
      "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
      "todoTitle": "Make Money",
      "todoNotes": "If we're not making money, it's a hobby.",
      "todoDateDue": "2014-11-03 14:22:18"
  }

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "GET"
          },
          "userRead": {
              "href": "/users/f371d6e3-1a54-450d-99a2-85adfbbabed1",
              "method": "GET"
          },
          "todoEdit": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo",
              "data": {
                  "todoTitle": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  },
                  "todoDateDue": {
                      "type": "date",
                      "required": false
                  },
                  "todoNotes": {
                      "minlength": 4,
                      "maxlength": 10000,
                      "type": "string",
                      "required": false
                  }
              }
          },
          "todoDelete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710",
              "method": "DELETE",
              "title": "Delete Todo"
          },
          "todoComplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/complete",
              "method": "PUT",
              "title": "Complete Todo"
          },
          "todoIncomplete": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/incomplete",
              "method": "PUT",
              "title": "Incomplete Todo"
          },
          "todoSend": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/send",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Complete Todo",
              "data": {
                  "userid": {
                      "minlength": 4,
                      "maxlength": 50,
                      "type": "string",
                      "required": true
                  }
              }
          },
          "todoEditDateDue": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/editdatedue",
              "method": "PUT",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Edit Todo Date Due",
              "data": {
                  "todoDateDue": {
                      "type": "date",
                      "required": true
                  }
              }
          },
          "todoCategoryCreate": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Add Category to Todo",
              "data": {
                  "categoryid": {
                      "type": "string",
                      "required": true
                  }
              }
          },
          "categoryList": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "GET"
          }
      },
      "todoid": "48937341-e8ab-4774-8228-64f2acbda710",
      "todoTitle": "Make Money",
      "todoNotes": "If we're not making money, it's a hobby.",
      "todoDateDue": "2014-11-03 14:22:18",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

todoDelete [DELETE]

  • Response 204

Complete a Todo [/todos/{todoid}/complete]

Complete a Todo

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoComplete [PUT]

  • Response 204

Incomplete a Todo [/todos/{todoid}/incomplete]

Complete a Todo

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoIncomplete [PUT]

  • Response 204

Send a Todo [/todos/{todoid}/send]

Send a Todo

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoSend [PUT]

  • Request Update a User (application/json)

      {
      "userid": "48937341-e8ab-4774-8228-64f2acbda710"
  }

  • Response 204

Edit a Todo DateDue [/todos/{todoid}/editdatedue]

Edit a Todo DateDue

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoEditDateDue [PUT]

  • Request Update a User (application/json)

      {
      "todoDateDue": "2014-11-03 14:22:18"
  }

  • Response 204

Todo Categories [/todos/{todoid}/categories]

Update the category list for a todo to include an additional category.

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique todoid of the todo

todoCategoryCreate [POST]

  • Request Update a User (application/json)

      {
      "categoryid": "ec210ff9-7b29-4784-82b2-7b4958618c30"
  }

  • Response 204

todoCategoryList [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "title": "This Collection"
          },
          "first": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories?offset=0",
              "title": "First Page of this Collection"
          },
          "prev": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories?offset=0",
              "title": "Previous Page of this Collection"
          },
          "next": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories?offset=0",
              "title": "Next Page of this Collection"
          },
          "last": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories?offset=0",
              "title": "Last Page of this Collection"
          },
          "todoCategoryCreate": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories",
              "method": "POST",
              "request_encoding": "application/x-www-form-urlencoded",
              "title": "Create A Category",
              "data": {
                  "categoryid": {
                      "type": "string",
                      "required": true
                  }
              }
          }
      },
      "_embedded": {
          "todoCategories": [
              {
                  "_links": {
                      "self": {
                          "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "GET"
                      },
                      "categoryRead": {
                          "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
                          "method": "GET"
                      }
                  },
                  "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
                  "title": "A1 Priority",
                  "created_at: "2014-11-03 14:22:18",
                  "updated_at: "2014-11-03 14:22:18"
              }
          ]
      },
      "total_items": "1",
      "returned_items": 1,
      "limit": 20,
      "offset": 0
  }

Todo Category [/todos/{todoid}/categories/{categoryid}]

Update the category list for a todo to include an additional category.

  • Parameters
    • todoid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique id of the todo
    • categoryid (required, string, f371d6e3-1a54-450d-99a2-85adfbbabed1) ... The unique id of the category

todoCategoryRead [GET]

  • Response 200 (application/vnd.hale+json)

      {
      "_links": {
          "self": {
              "href": "/todos/48937341-e8ab-4774-8228-64f2acbda710/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "GET"
          },
          "categoryRead": {
              "href": "/categories/ec210ff9-7b29-4784-82b2-7b4958618c30",
              "method": "GET"
          }
      },
      "categoryid": "f371d6e3-1a54-450d-99a2-85adfbbabed1",
      "title": "A1 Priority",
      "created_at: "2014-11-03 14:22:18",
      "updated_at: "2014-11-03 14:22:18"
  }

todoRemoveCategory [DELETE]

  • Response 204

Home :: Code of Conduct :: People :: Agenda :: Travel :: What Is RestFest?

Add a custom sidebar
Clone this wiki locally