Skip to content

Latest commit

 

History

History
308 lines (204 loc) · 6.12 KB

README.md

File metadata and controls

308 lines (204 loc) · 6.12 KB
Raw

Get ENT History Extra

Returns json data about a single ENT history extra resource.

  • URL

    /tscharts/v1/enthistoryextra/id

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content:

    {"id" : id, "enthistory" : id, "time" : UTC date time string, "name": string name of condition, "duration": "none" | "days" | "weeks" | "months" | "intermittent", "side" : "right" | "left" | "both", "none"}

  • Error Response:

    • Code: 404 NOT FOUND

  • Example:

GET /tscharts/v1/enthistoryextra/12/ HTTP/1.1
Host: localhost
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:24 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json

2c5
{"id" : 27, "enthistory" : 9, "time" : "2017-12-11T01:02:24", "name": "Condition", "duration":  "weeks", "side": "left"}

Get Multiple ENT History Extra Resources

Returns data about all matching ENT history extra resources.

  • URL

    /tscharts/v1/enthistoryextra/

  • Method:

    GET

  • URL Params

    Required:

    enthistory related enthistory record in database id

    Optional:

    name condition name

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content:

    [{"id" : id, "enthistory" : id, "time" : UTC date time string, "name": string, "duration": "none" | "days" | "weeks" | "months" | "intermittent", "side" : "right" | "left" | "both"}, ...]

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 403 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

GET /tscharts/v1/enthistoryextra/?enthistory=9 HTTP/1.1
Host: localhost
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:24 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json


859
[{"id" : 27, "enthistory" : 9, "time" : "2017-12-11T01:02:24", "name": "Condition", "duration":  "weeks", "side": "left"}, ...]
0

Create an ENT History Extra Resource

Create an ENT history extra resource

  • URL

    /tscharts/v1/enthistoryextra/

  • Method:

    POST

  • URL Params

    None

  • Data Params

    Required:

    enthistory enthistory resource id
    'name' name of the condition, less than equal to 64 characters
    side one of "left", "right", "none", or "both"
    duration one of "none", "days", "weeks", "months" or "intermittent"

    Optional:

    None

  • Success Response:

    • Code: 200
      Content: { "id" : id }

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 404 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

POST /tscharts/v1/enthistoryextra/ HTTP/1.1
Host: localhost
Content-Length: 738
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{"enthistory" : 9, "name" : "somethingitis": "username", "Fred", "side": "both", "duration": "intermittent"}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:23 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json


8
{"id":2}
0

Update an ENT History Extra Record

Update an ENT history extra instance

  • URL

    /tscharts/v1/enthistoryextra/id

  • Method:

    PUT

  • URL Params

    None

  • Data Params

    Required:

    One or more of the following field/value pairs

    enthistory enthistory resource id
    'name' name of the condition, less than equal to 64 characters
    side one of "left", "right", "none", or "both"
    duration one of "none", "days", "weeks", "months" or "intermittent"

  • Success Response:

    • Code: 200

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 404 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

PUT /tscharts/v1/enthistoryextra/24/ HTTP/1.1
Host: 127.0.0.1:8000
Content-Length: 18
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token b4e9102f85686fda0239562e4c8f7d3773438dae


{"name": "a new name"}HTTP/1.0 200 OK
Date: Sun, 23 Apr 2017 01:19:21 GMT
Server: WSGIServer/0.1 Python/2.7.6
Vary: Accept
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS


{}

Delete an ENT history extra

Delete an ENT history extra resource. Use is not recommended except for unit test applications.

  • URL

    /tscharts/v1/enthistory/id

  • Method:

    DELETE

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: None

  • Error Response:

    • Code: 404 NOT FOUND

  • Example:

DELETE /tscharts/v1/enthistory/140/ HTTP/1.1
Host: 127.0.0.1:8000
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.0 200 OK
Date: Fri, 21 Apr 2017 05:52:49 GMT
Server: WSGIServer/0.1 Python/2.7.6
Vary: Accept
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS


{}