api-docs v5.116.0

API Docs

Table of contents

Insurance_Contract

Contract - Delete

Back to top

Delete insurance-contracts with details

DELETE /insurance-contracts/:id

Headers - Header

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 insurance-contract

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

unix timestamp
createdBy string
type string

Types (insurer-insured pattern)

  • insurance-facility
  • insurance-doctor
  • insurance-patient
  • corporate-partner-facility
  • corporate-partner-patient
insured string

facility id for facility contract, doc id for private doctors
insurer string

for insurance companies, the insurance company id; for coroporate partnership, same as id
insurerSubtype string
insurerPicURL string
insurerName string
insurerDescription string
insurerNo string

external reference no

Use-cases

  • as account id (medicard)
label string

label
expiresAt number

expiration
startAt number

start
endAt number

end
meta Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-contract-id",
  "type": "insurance-facility",
  "insured": "<insured-organizations-id>",
  "insurer": "<insured-organizations-id>"
  "insurerName": "Insurer's name"
}

Contract - Find

Back to top

Get an insurance-contract's details

GET /insurance-contracts

Headers - Header

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/insurance-contracts" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
insuranceContracts Object[]

array of insurance contract
insuranceContracts.id string
insuranceContracts.createdAt number

unix timestamp
insuranceContracts.createdBy string
insuranceContracts.type string

Types (insurer-insured pattern)

  • insurance-facility
  • insurance-doctor
  • insurance-patient
  • corporate-partner-facility
  • corporate-partner-patient
insuranceContracts.insured string

facility id for facility contract, doc id for private doctors
insuranceContracts.insurer string

for insurance companies, the insurance company id; for coroporate partnership, same as id
insuranceContracts.insurerSubtype string
insuranceContracts.insurerPicURL string
insuranceContracts.insurerName string
insuranceContracts.insurerDescription string
insuranceContracts.insurerNo string

external reference no

Use-cases

  • as account id (medicard)
insuranceContracts.label string

label
insuranceContracts.expiresAt number

expiration
insuranceContracts.startAt number

start
insuranceContracts.endAt number

end
insuranceContracts.meta Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "insurance-contract-id",
    "type": "insurance-facility",
    "insured": "<insured-organizations-id>",
    "insurer": "<insured-organizations-id>"
    "insurerName": "Insurer's name"
  },
  {
    "id": "insurance-contract-id",
    "type": "insurance-facility",
    "insured": "<insured-organizations-id>",
    "insurer": "<insured-organizations-id>"
    "insurerName": "Insurer's name"
  }
]

Contract - Get

Back to top

Get insurance-contracts with details

GET /insurance-contracts/:id

Headers - Header

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 insurance-contract

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

unix timestamp
createdBy string
type string

Types (insurer-insured pattern)

  • insurance-facility
  • insurance-doctor
  • insurance-patient
  • corporate-partner-facility
  • corporate-partner-patient
insured string

facility id for facility contract, doc id for private doctors
insurer string

for insurance companies, the insurance company id; for coroporate partnership, same as id
insurerSubtype string
insurerPicURL string
insurerName string
insurerDescription string
insurerNo string

external reference no

Use-cases

  • as account id (medicard)
label string

label
expiresAt number

expiration
startAt number

start
endAt number

end
meta Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-contract-id",
  "type": "insurance-facility",
  "insured": "<insured-organizations-id>",
  "insurer": "<insured-organizations-id>"
  "insurerName": "Insurer's name"
}

Contract - Patch

Back to top

Update a insurance-contract

PATCH /insurance-contracts/:id

Headers - Header

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 insurance-contract
insurerNo string optional

external reference no

Use-cases

  • as account id (medicard)
label string optional

label
expiresAt number optional

expiration
startAt number optional

start
endAt number optional

end
meta Object optional

Examples

Example usage:

curl "https://yourdomain.com/insurance-contracts/<insurance-contract-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "label": "Updated Value"
  }'

Parameters examples

json - Request-Example

{
  "label": "Updated Value"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

unix timestamp
createdBy string
type string

Types (insurer-insured pattern)

  • insurance-facility
  • insurance-doctor
  • insurance-patient
  • corporate-partner-facility
  • corporate-partner-patient
insured string

facility id for facility contract, doc id for private doctors
insurer string

for insurance companies, the insurance company id; for coroporate partnership, same as id
insurerSubtype string
insurerPicURL string
insurerName string
insurerDescription string
insurerNo string

external reference no

Use-cases

  • as account id (medicard)
label string

label
expiresAt number

expiration
startAt number

start
endAt number

end
meta Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-contract-id",
  "type": "insurance-facility",
  "insured": "<insured-organizations-id>",
  "insurer": "<insured-organizations-id>"
  "insurerName": "Insurer's name"
}

Contract - Post

Back to top

Create a insurance-contract

POST /insurance-contracts

Headers - Header

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
type string Allowed values: "insurance-facility","insurance-doctor","insurance-doctor","insurance-patient","corporate-partner-facility","corporate-partner-patient"
insured string optional

facility id for facility contract, doc id for private doctors
insurer string optional

for insurance companies, the insurance company id; for coroporate partnership, same as id
insurerNo string optional

external reference no

Use-cases

  • as account id (medicard)
label string optional

label
expiresAt number optional

expiration
startAt number optional

start
endAt number optional

end
meta Object optional

Examples

Example usage:

curl "https://yourdomain.com/insurance-contracts" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "insurance-facility",
    "insured": "<insured-organizations-id>",
    "insurer": "<insured-organizations-id>"
  }'

Parameters examples

json - Request-Example

{
  "type": "insurance-facility",
  "insured": "<insured-organizations-id>",
  "insurer": "<insured-organizations-id>"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

unix timestamp
createdBy string
type string

Types (insurer-insured pattern)

  • insurance-facility
  • insurance-doctor
  • insurance-patient
  • corporate-partner-facility
  • corporate-partner-patient
insured string

facility id for facility contract, doc id for private doctors
insurer string

for insurance companies, the insurance company id; for coroporate partnership, same as id
insurerSubtype string
insurerPicURL string
insurerName string
insurerDescription string
insurerNo string

external reference no

Use-cases

  • as account id (medicard)
label string

label
expiresAt number

expiration
startAt number

start
endAt number

end
meta Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-contract-id",
  "type": "insurance-facility",
  "insured": "<insured-organizations-id>",
  "insurer": "<insured-organizations-id>"
  "insurerName": "Insurer's name"
}

results matching ""

    No results matching ""