/foo/:name/:type

lorem ipsum

Path-Parameters

path

{
  "name": String,
  "type": String,
}
FieldDescription
nameString
Name parameter
MaxLength
16
Pattern
[A-z]+
typeString
Enum
  • "foo"
  • "bar"

GET

Returns a collection

GET Query-Parameters

GetQuery

{
  "startIndex": Integer,
  "float": Number,
  "boolean": Boolean,
  "date": Date,
  "datetime": DateTime,
}
FieldDescription
startIndexInteger
startIndex parameter
Maximum
32
floatNumber
booleanBoolean
dateDate
datetimeDateTime

GET Response - 200 OK

collection

{
  "entry": Array (Object (item)),
}
FieldDescription
entryArray (Object (item))

item

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

POST

POST Request

item

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

POST Response - 201 Created

message

{
  "success": Boolean,
  "message": String,
}
FieldDescription
successBoolean
messageString

PUT

PUT Request

item

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

PUT Response - 200 OK

message

{
  "success": Boolean,
  "message": String,
}
FieldDescription
successBoolean
messageString

DELETE

DELETE Request

item

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

DELETE Response - 200 OK

message

{
  "success": Boolean,
  "message": String,
}
FieldDescription
successBoolean
messageString

PATCH

PATCH Request

item

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

PATCH Response - 200 OK

message

{
  "success": Boolean,
  "message": String,
}
FieldDescription
successBoolean
messageString