api-docs v5.45.0

API Docs

Fixture

Fixture - Post

Back to top

Create a fixture

POST /fixtures

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
code String

[for icd10, specialty, profession]
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
designation String

[for address-region, address-province, address-municipality, address-barangay]
country String

[for address-region, address-province, address-municipality, address-barangay] - country id
region String

[address-province, address-municipality, address-barangay] - region id
province String

[address-municipality, address-barangay] - province id
municipality String

[address-barangay] - municipality id

Examples

Example usage:

curl "https://yourdomain.com/fixtures" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "code": "some-icd10-code",
    "text": "icd10 fixture text"
  }'

Parameters examples

json - Request-Example

{
  "code": "some-icd10-code",
  "text": "icd10 fixture text"
}

Success response

Success response - Success 200

Name Type Description
id string
type String

icd10, specialty, profession, address-country, address-region, address-province, address-municipality, address-barangay
createdAt Number
createdBy String
code String

[for icd10, specialty, profession]
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
designation String

[for address-region, address-province, address-municipality, address-barangay]
country String

[for address-region, address-province, address-municipality, address-barangay] - country id
region String

[address-province, address-municipality, address-barangay] - region id
province String

[address-municipality, address-barangay] - province id
municipality String

[address-barangay] - municipality id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "fixture-id",
  "type": "icd10",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "code": "some-icd10-code",
  "text": "icd10 fixture text"
}

Fixture - Delete

Back to top

Delete a fixture's details

DELETE /fixtures/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of fixture

Examples

Example usage:

curl "https://yourdomain.com/fixtures/<fixture-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
type String

icd10, specialty, profession, address-country, address-region, address-province, address-municipality, address-barangay
createdAt Number
createdBy String
code String

[for icd10, specialty, profession]
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
designation String

[for address-region, address-province, address-municipality, address-barangay]
country String

[for address-region, address-province, address-municipality, address-barangay] - country id
region String

[address-province, address-municipality, address-barangay] - region id
province String

[address-municipality, address-barangay] - province id
municipality String

[address-barangay] - municipality id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "fixture-id",
  "type": "icd10",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "code": "some-icd10-code",
  "text": "icd10 fixture text"
}

Fixture - Find

Back to top

Get fixtures with details

GET /fixtures

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/fixtures" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
fixtures Object[]

array of fixture
fixtures.id string
fixtures.type String

icd10, specialty, profession, address-country, address-region, address-province, address-municipality, address-barangay
fixtures.createdAt Number
fixtures.createdBy String
fixtures.code String

[for icd10, specialty, profession]
fixtures.text String

[for icd10, specialty, profession]
fixtures.name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
fixtures.designation String

[for address-region, address-province, address-municipality, address-barangay]
fixtures.country String

[for address-region, address-province, address-municipality, address-barangay] - country id
fixtures.region String

[address-province, address-municipality, address-barangay] - region id
fixtures.province String

[address-municipality, address-barangay] - province id
fixtures.municipality String

[address-barangay] - municipality id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "fixture-id",
    "type": "icd10",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "code": "some-icd10-code",
    "text": "icd10 fixture text"
  },
  {
    "id": "fixture-id",
    "type": "icd10",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "code": "some-icd10-code",
    "text": "icd10 fixture text"
  }
]

Fixture - Get

Back to top

Get a fixture's details

GET /fixtures/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of fixture

Examples

Example usage:

curl "https://yourdomain.com/fixtures/<fixture-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
type String

icd10, specialty, profession, address-country, address-region, address-province, address-municipality, address-barangay
createdAt Number
createdBy String
code String

[for icd10, specialty, profession]
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
designation String

[for address-region, address-province, address-municipality, address-barangay]
country String

[for address-region, address-province, address-municipality, address-barangay] - country id
region String

[address-province, address-municipality, address-barangay] - region id
province String

[address-municipality, address-barangay] - province id
municipality String

[address-barangay] - municipality id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "fixture-id",
  "type": "icd10",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "code": "some-icd10-code",
  "text": "icd10 fixture text"
}

Fixture - Patch

Back to top

Update a fixture

PATCH /fixtures/:id

Headers

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of fixture
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]

Examples

Example usage:

curl "https://yourdomain.com/fixtures/<fixture-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "code": "some-icd10-code",
    "text": "icd10 fixture text"
  }'

Parameters examples

json - Request-Example

{
  "text": "icd10 fixture text"
}

Success response

Success response - Success 200

Name Type Description
id string
type String

icd10, specialty, profession, address-country, address-region, address-province, address-municipality, address-barangay
createdAt Number
createdBy String
code String

[for icd10, specialty, profession]
text String

[for icd10, specialty, profession]
name String

[for address-country, address-region, address-province, address-municipality, address-barangay]
designation String

[for address-region, address-province, address-municipality, address-barangay]
country String

[for address-region, address-province, address-municipality, address-barangay] - country id
region String

[address-province, address-municipality, address-barangay] - region id
province String

[address-municipality, address-barangay] - province id
municipality String

[address-barangay] - municipality id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "fixture-id",
  "type": "icd10",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "code": "some-icd10-code",
  "text": "icd10 fixture text"
}

results matching ""

    No results matching ""