Skip to content

Latest commit

 

History

History
306 lines (202 loc) · 5.91 KB

README.md

File metadata and controls

306 lines (202 loc) · 5.91 KB
Raw

Get ENT Diagnosis Extra

Returns json data about a single ENT diagnosis extra resource.

  • URL

    /tscharts/v1/entdiagnosisextra/id

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content:

    {"id" : id, "entdiagnosis" : id, "time" : UTC date time string, "name": string, "value": text}

  • Error Response:

    • Code: 404 NOT FOUND

  • Example:

GET /tscharts/v1/entdiagnosisextra/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, "entdiagnosis" : 9, "time" : "2017-12-11T01:02:24", "name": "Condition", "value":  "This was seen in both left and right ears, 70%"}

Get Multiple ENT Diagnosis Extra Resources

Returns data about all matching ENT diagnosis extra resources.

  • URL

    /tscharts/v1/entdiagnosisextra/

  • Method:

    GET

  • URL Params

    Required:

    entdiagnosis related entdiagnosis record in database id

    Optional:

    name condition name, partial ok (e.g., "ea" would match all names that contain substring "ea")

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: [{"id" : id, "entdiagnosis" : id, "time" : date time string, "name": name of condition, "value": text of diagnosis}, ...]

  • Error Response:

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

  • Example:

GET /tscharts/v1/entdiagnosisextra/?entdiagnosis=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, "entdiagnosis" : 9, "time" : "2017-12-11T01:02:24", "name": "Condition", "value":  "This was seen in both left and right ears, 70%"}, ...]
0

Create an ENT Diagnosis Extra Resource

Create an ENT diagnosis extra resource

  • URL

    /tscharts/v1/entdiagnosisextra/

  • Method:

    POST

  • URL Params

    None

  • Data Params

    Required:

    entdiagnosis entdiagnosis resource id
    'name' name of the diagnosis, less than equal to 64 characters value free form text describing the diagnosis

    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/entdiagnosisextra/ 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


{"entdiagnosis" : 9, "name" : "somethingitis": "value", "condition is acute, attentuation is high"}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 Diagnosis Extra

Update an ENT diagnosis extra instance

  • URL

    /tscharts/v1/entdiagnosisextra/id

  • Method:

    PUT

  • URL Params

    None

  • Data Params

    Required:

    One or more of the following field/value pairs

    entdiagnosis related ent diagnosis resource id
    name name of the extra diagnosis
    'value' text describing the diagnosis

  • Success Response:

    • Code: 200

  • Error Response:

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

  • Example:

PUT /tscharts/v1/entdiagnosisextra/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 diagnosis extra

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

  • URL

    /tscharts/v1/entdiagnosis/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/entdiagnosis/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


{}