api-docs v5.116.0

API Docs

Table of contents

Account_Configuration

Account Configuration - Delete

Back to top

Delete account-configuration user. User deleting should be the owner

DELETE /account-configurations/: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>"
}

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
uid String

account's (u)id
emr Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-1-id",
  "uid": "account-1-uid",
}

Account Configuration - Find

Back to top

Get list of account configurations

GET /account-configurations

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

Success response

Success response - Success 200

Name Type Description
accountConfigurations[] Object[]

array of accountConfiguration
accountConfigurations.id String
accountConfigurations.uid String

account's (u)id
accountConfigurations.emr Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "account-1-id",
    "uid": "account-1-uid"
  },
  {
    "id": "account-2-id",
    "uid": "account-2-uid"
  }
]

Account Configuration - Get

Back to top

Get account-configuration of a user

GET /account-configurations/: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 account

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
uid String

account's (u)id
emr Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-1-id",
  "uid": "account-1-uid",
}

Account Configuration - Patch

Back to top

Update an account configuration

PATCH /account-configurations/: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
emr object

Examples

Example usage:

curl "https://yourdomain.com/account-configurations/<account-configuration-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "emr": {
      "key": "value"
    }
  }'

Parameters examples

json - Request-Example

{
  "emr": {
    "key": "value"
  }
}

Success response

Success response - Success 200

Name Type Description
id String
uid String

account's (u)id
emr Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-1-id",
  "uid": "account-1-uid",
}

Account Configuration - Post

Back to top

Create account configuration

POST /account-configurations

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
emr object

Examples

Example usage:

curl "https://yourdomain.com/account-configurations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "emr": {
      "key": "value"
    }
  }'

Parameters examples

json - Request-Example

{
  "emr": {
    "key": "value"
  }
}

Success response

Success response - Success 200

Name Type Description
id String
uid String

account's (u)id
emr Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "account-1-id",
  "uid": "account-1-uid",
}

results matching ""

    No results matching ""