/prmd-sample

Prmd sample

App

FIXME

Attributes

Name Type Description Example
created_at date-time when app was created "2012-01-01T12:00:00Z"
id uuid unique identifier of app "01234567-89ab-cdef-0123-456789abcdef"
updated_at date-time when app was updated "2012-01-01T12:00:00Z"

App Create

Create a new app.

POST /apps

Curl Example

$ curl -n -X POST https://api.hello.com/apps \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 201 Created

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

App Delete

Delete an existing app.

DELETE /apps/{app_id}

Curl Example

$ curl -n -X DELETE https://api.hello.com/apps/$APP_ID \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

App Info

Info for existing app.

GET /apps/{app_id}

Curl Example

$ curl -n -X GET https://api.hello.com/apps/$APP_ID

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

App List

List existing apps.

GET /apps

Curl Example

$ curl -n -X GET https://api.hello.com/apps

Response Example

HTTP/1.1 200 OK

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

App Update

Update an existing app.

PATCH /apps/{app_id}

Curl Example

$ curl -n -X PATCH https://api.hello.com/apps/$APP_ID \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

Post

FIXME

Attributes

Name Type Description Example
created_at date-time when post was created "2012-01-01T12:00:00Z"
id uuid unique identifier of post "01234567-89ab-cdef-0123-456789abcdef"
updated_at date-time when post was updated "2012-01-01T12:00:00Z"

Post Create

Create a new post.

POST /posts

Curl Example

$ curl -n -X POST https://api.hello.com/posts \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 201 Created

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

Post Delete

Delete an existing post.

DELETE /posts/{post_id}

Curl Example

$ curl -n -X DELETE https://api.hello.com/posts/$POST_ID \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

Post Info

Info for existing post.

GET /posts/{post_id}

Curl Example

$ curl -n -X GET https://api.hello.com/posts/$POST_ID

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}

Post List

List existing posts.

GET /posts

Curl Example

$ curl -n -X GET https://api.hello.com/posts

Response Example

HTTP/1.1 200 OK

[
  {
    "created_at": "2012-01-01T12:00:00Z",
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

Post Update

Update an existing post.

PATCH /posts/{post_id}

Curl Example

$ curl -n -X PATCH https://api.hello.com/posts/$POST_ID \
  -H "Content-Type: application/json" \

Response Example

HTTP/1.1 200 OK

{
  "created_at": "2012-01-01T12:00:00Z",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "updated_at": "2012-01-01T12:00:00Z"
}