REST API format example

REST API.md

Models

Dog

{
  id: *<String>*,
  name: *<String>*,
  ownerId: *<Human>*,
  dateOfBirth: *<DateTime>*,
  breed: *<Enum>*
}

Human

{
  id: *<GUID>*,
  name: *<String>*
}

Dogs API parameters

{
  includes: <String>[],
  idList: <GUID>[],
  idNotList: <GUID>[],
  nameContains: <String>,
  dateOfBirthGTE: <DateTime>,
  dateOfBirthLTE: <DateTime>,
  breedList: <Enum>[],
  breedNotList: <Enum>[]
}

Example request:

GET /dogs/?includes=owner&nameContains=Chomp

Response

{
  dogs: [
    {
      id: "123",
      name: "Mr Chompers",
      ownerId: "098",
      dateOfBirth: datetimewhatever
    },
    {
      id: "234",
      name: "Little Chompers",
      ownerId: "098",
      dateOfBirth: datetimewhatever
    },
    {
      id: "345",
      name: "Chomp Chomp",
      ownerId: "987",
      dateOfBirth: datetimewhatever
    }
  ],
  humans: [
    {
      id: "098",
      name: Frank McDogowner
    },
    {
      id: "987",
      name: Jose McPerroowner
    }
  ]
}