ECG (1.0)

Download OpenAPI specification:Download

Documentation

Authentication

bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Health

Checks health of the server

Responses
200

The Health Check is successful

503

The Health Check is not successful

get/healthcheck
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/healthcheck
Response samples
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

Applications

Lists available Application Audit Trails for all Applications.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/applications/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/applications/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Application.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
description
required
string
cognitoAppId
string
modules
Array of strings
Responses
201
post/api/applications
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string | null",
  • "modules": [
    ]
}
Response samples
application/json
{
  • "id": "4c1436c1-0a23-42af-9ccd-52ad21754117",
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "modules": [
    ]
}

Lists all the available Applications.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: name or description

include
string

For query include=modules, it returns applications with modules ,if exists

Value: "modules"
sort_by
string

Default value : id

Example: sort_by=id
Responses
200
get/api/applications
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/applications?order_by=ASC&skip=0&take=10&searchTerm=string&include=modules&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
query Parameters
include
string

For query include=modules it returns application with modules,if exists

Value: "modules"
Responses
200
get/api/applications/{applicationId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/applications/{applicationId}?include=modules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "4c1436c1-0a23-42af-9ccd-52ad21754117",
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "modules": [
    ]
}

Deletes the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
delete/api/applications/{applicationId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/applications/{applicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Application information by updating the items they were provided.

Request
Security:
bearer
path Parameters
applicationId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/applications/{applicationId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "4c1436c1-0a23-42af-9ccd-52ad21754117",
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "modules": [
    ]
}

Gets Modules associated with Application.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
get/api/applications/{applicationId}/modules
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/modules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "4c1436c1-0a23-42af-9ccd-52ad21754117",
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "modules": [
    ]
}

Associates ModuleIds with Application.

Request
Security:
bearer
path Parameters
applicationId
required
string
Request Body schema: application/json
moduleIds
required
Array of strings
Responses
200
post/api/applications/{applicationId}/modules
Request samples
application/json
{
  • "moduleIds": [
    ]
}
Response samples
application/json
{
  • "id": "4c1436c1-0a23-42af-9ccd-52ad21754117",
  • "name": "string",
  • "description": "string",
  • "cognitoAppId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "modules": [
    ]
}

Archives the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
post/api/applications/{applicationId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
post/api/applications/{applicationId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activates the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
post/api/applications/{applicationId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Application information.

Request
Security:
bearer
path Parameters
applicationId
required
string
Responses
200
post/api/applications/{applicationId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists available Application Audit Trails for given ApplicationId.

Request
Security:
bearer
path Parameters
applicationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/applications/{applicationId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/applications/{applicationId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Modules

Lists available Module Audit Trails for all Modules

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/modules/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/modules/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Module Audit Trails for given moduleId

Request
Security:
bearer
path Parameters
moduleId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/modules/{moduleId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Module.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
description
string
Responses
201
post/api/modules
Request samples
application/json
{
  • "name": "string",
  • "description": "string | null"
}
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Lists the available Modules.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: name or description

include
Array of strings

For query include=permissions it returns module with permissions ,if exists

Items Enum: "permissions" "applications"
sort_by
string

Default value : id

Example: sort_by=id
Responses
200
get/api/modules
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/modules?order_by=ASC&skip=0&take=10&searchTerm=string&include=permissions&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Associates Applications with the Module.

Request
Security:
bearer
path Parameters
moduleId
required
string
Request Body schema: application/json
applicationIds
required
Array of strings
Responses
200
post/api/modules/{moduleId}/applications
Request samples
application/json
{
  • "applicationIds": [
    ]
}
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Gets the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
query Parameters
include
Array of strings

For query include=permissions it returns module with permissions ,if exists

Items Enum: "permissions" "applications"
Responses
200
get/api/modules/{moduleId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/modules/{moduleId}?include=permissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Deletes the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
Responses
200
delete/api/modules/{moduleId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/modules/{moduleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Module information by updating the items they were provided.

Request
Security:
bearer
path Parameters
moduleId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/modules/{moduleId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Gets Permissions associated with Module.

Request
Security:
bearer
path Parameters
moduleId
required
string
query Parameters
searchTerm
any

Search By: 025d7265-e94c-4993-a1aa-16b91814585b

Responses
200
get/api/modules/{moduleId}/permissions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/permissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Adds module with permissions

Request
Security:
bearer
path Parameters
moduleId
required
string
Request Body schema: application/json
permissionIds
required
Array of strings
Responses
200
post/api/modules/{moduleId}/permissions
Request samples
application/json
{
  • "permissionIds": [
    ]
}
Response samples
application/json
{
  • "id": "44af22f0-507d-4cfe-886c-16f33df91c6c",
  • "name": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "permissions": [
    ],
  • "applications": [
    ]
}

Deletes the application information from module

Request
Security:
bearer
path Parameters
moduleId
required
string
applicationId
required
string
Responses
200
delete/api/modules/{moduleId}/application/{applicationId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/application/{applicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Archives the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
Responses
200
post/api/modules/{moduleId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
Responses
200
post/api/modules/{moduleId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
Responses
200
post/api/modules/{moduleId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Module information.

Request
Security:
bearer
path Parameters
moduleId
required
string
Responses
200
post/api/modules/{moduleId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/modules/{moduleId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Permissions

Lists available Permission Audit Trails for all the Permissions.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/permissions/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/permissions/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Permission.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
description
string
moduleId
required
string
Responses
201
post/api/permissions
Request samples
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string | null",
  • "moduleId": "688e6951-371c-446b-9d47-cb4b5e7d02d0"
}
Response samples
application/json
{
  • "id": "7e97dc50-02e2-499d-af2e-845d95b7fd13",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "module": {
    },
  • "policies": [
    ]
}

Lists the available Permissions.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: name, code or description

include
Array of strings

For query include=module it returns permissions with module,if exists

Items Enum: "policies" "module"
sort_by
string

Default value : id

Example: sort_by=id
Responses
200
get/api/permissions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/permissions?order_by=ASC&skip=0&take=10&searchTerm=string&include=policies&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
query Parameters
include
Array of strings

For query include=module it returns permissions with module,if exists

Items Enum: "policies" "module"
Responses
200
get/api/permissions/{permissionId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}?include=policies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "7e97dc50-02e2-499d-af2e-845d95b7fd13",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "module": {
    },
  • "policies": [
    ]
}

Deletes the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
Responses
200
delete/api/permissions/{permissionId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Permission information by updating the items they were provided.

Request
Security:
bearer
path Parameters
permissionId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/permissions/{permissionId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "7e97dc50-02e2-499d-af2e-845d95b7fd13",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "module": {
    },
  • "policies": [
    ]
}

Adds Module with Permission.

Request
Security:
bearer
path Parameters
permissionId
required
string
moduleId
required
string
Responses
200
patch/api/permissions/{permissionId}/modules/{moduleId}
Request samples
curl -i -X PATCH \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/modules/{moduleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "7e97dc50-02e2-499d-af2e-845d95b7fd13",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "module": {
    },
  • "policies": [
    ]
}

Archives the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
Responses
200
post/api/permissions/{permissionId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
Responses
200
post/api/permissions/{permissionId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
Responses
200
post/api/permissions/{permissionId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Permission information.

Request
Security:
bearer
path Parameters
permissionId
required
string
Responses
200
post/api/permissions/{permissionId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Permission Audit Trails for given Permission Id.

Request
Security:
bearer
path Parameters
permissionId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/permissions/{permissionId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/permissions/{permissionId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Policies

Lists available Policy Audit Trails for all the Policies.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/policies/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policies/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Policy.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
description
string
organizationId
string
permissions
Array of strings
internalUseOnly
boolean
Responses
201
post/api/policies
Request samples
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string | null",
  • "organizationId": "fd019d9f-62bd-4a6c-9b2e-3d7f52b864d2",
  • "permissions": [
    ],
  • "internalUseOnly": false
}
Response samples
application/json
{
  • "id": "0820bd5b-4b4b-4da7-a12f-a52c81874523",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "IsInUse": false,
  • "internalUseOnly": false,
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organization": {
    },
  • "permissions": [
    ]
}

Lists all the available Policies.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: name, code or description

include
Array of strings

For query include=permissions it returns permissions with policy,if exists

Items Enum: "permissions" "organization"
sort_by
string

Default value : id

Example: sort_by=id
includeInternalUseOnly
string

Default Value: false

Enum: "true" "false"
Example: includeInternalUseOnly=false
Responses
200
get/api/policies
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policies?order_by=ASC&skip=0&take=10&searchTerm=string&include=permissions&sort_by=string&includeInternalUseOnly=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
query Parameters
include
Array of strings

For query include=permissions it returns policy with permissions,if exists

Items Enum: "permissions" "organization"
Responses
200
get/api/policies/{policyId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policies/{policyId}?include=permissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "0820bd5b-4b4b-4da7-a12f-a52c81874523",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "IsInUse": false,
  • "internalUseOnly": false,
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organization": {
    },
  • "permissions": [
    ]
}

Deletes the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
Responses
200
delete/api/policies/{policyId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/policies/{policyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Policy information by updating the items they were provided.

Request
Security:
bearer
path Parameters
policyId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/policies/{policyId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "0820bd5b-4b4b-4da7-a12f-a52c81874523",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "IsInUse": false,
  • "internalUseOnly": false,
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organization": {
    },
  • "permissions": [
    ]
}

Deletes the permissions information from policy.

Request
Security:
bearer
path Parameters
policyId
required
string
permissionId
required
string
Responses
200
delete/api/policies/{policyId}/permissions/{permissionId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/policies/{policyId}/permissions/{permissionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Associates Permission and Policy .

Request
Security:
bearer
path Parameters
policyId
required
string
Request Body schema: application/json
permissionIds
required
Array of strings
Responses
200
post/api/policies/{policyId}/permissions
Request samples
application/json
{
  • "permissionIds": [
    ]
}
Response samples
application/json
{
  • "id": "0820bd5b-4b4b-4da7-a12f-a52c81874523",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "IsInUse": false,
  • "internalUseOnly": false,
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organization": {
    },
  • "permissions": [
    ]
}

Archives the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
Responses
200
post/api/policies/{policyId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policies/{policyId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
Responses
200
post/api/policies/{policyId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policies/{policyId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
Responses
200
post/api/policies/{policyId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policies/{policyId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Policy information.

Request
Security:
bearer
path Parameters
policyId
required
string
Responses
200
post/api/policies/{policyId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policies/{policyId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Policy Audit Trails for given Policy Id.

Request
Security:
bearer
path Parameters
policyId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/policies/{policyId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policies/{policyId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

PermissionCaches

Recaches all accounts.

Request
Security:
bearer
Responses
200
post/api/permission-caches/recache
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/permission-caches/recache \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Set Recache Flag for given User.

Request
Security:
bearer
path Parameters
cognitoUserId
required
string
query Parameters
recacheFlag
required
string
Enum: "true" "false"
Responses
200
post/api/permission-caches/{cognitoUserId}/set-recache-flag
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permission-caches/{cognitoUserId}/set-recache-flag?recacheFlag=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "accountId": "c3cfb2cb-7cb4-4c38-9a73-3cc5055ed4f4",
  • "recacheFl": "string",
  • "cacheObject": { },
  • "cognitoUserId": "d302052c-f1c0-41ff-a2f8-6ab1a1b08f05"
}

Get's Permission Cache information for user.

Request
Security:
bearer
path Parameters
cognitoUserId
required
string
Responses
200
post/api/permission-caches/{cognitoUserId}
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permission-caches/{cognitoUserId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "accountId": "c3cfb2cb-7cb4-4c38-9a73-3cc5055ed4f4",
  • "recacheFl": "string",
  • "cacheObject": { },
  • "cognitoUserId": "d302052c-f1c0-41ff-a2f8-6ab1a1b08f05"
}

This API serves the purpose of Re-caching the Account Permission information into the ACM for a particular user based on the 'type' of the UserId selected.

CONFLUENCE STORY - Recache Account Permission for a User
Request
Security:
bearer
path Parameters
userId
required
string
query Parameters
type
required
string

Default value: local , If type=idp, then we will perform the operation based on the 'cognitoUserId' where as If type=local, then we will perform the operation based on the 'personID'

Enum: "idp" "local"
Responses
200
post/api/permission-caches/{userId}/recache
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/permission-caches/{userId}/recache?type=idp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Organizations

Lists available Organization Audit Trails for all the Organizations.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/organizations/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Patches the Organization Metadata information by updating the items they were provided.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Adds the Organization metadata

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
Array
key
required
string
value
required
string
Responses
200
post/api/organizations/{organizationId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Delete the organization's metadata

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
field
required
string
Example: field=string
Responses
200
delete/api/organizations/{organizationId}/metadata
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/metadata?field=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Address information by updating the items they were provided.

Request
Security:
bearer
path Parameters
organizationId
required
string
addressId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/addresses/{addressId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Deletes an organization address information from the system based on the AddressId

Request
Security:
bearer
path Parameters
organizationId
required
string
addressId
required
string
Responses
200
delete/api/organizations/{organizationId}/addresses/{addressId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/addresses/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Organization information by metadata.

Request
Security:
bearer
query Parameters
field
required
string
Example: field=string
value
required
string
Example: value=string
Responses
200
get/api/organizations/metadata
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/metadata?field=string&value=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Organization Created Webhook API

Responses
200
post/api/integrations/apptivo/organizations-create
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/organizations-create
Response samples
application/json
{
  • "value": true
}

Re-sync Organization's Information using SNS.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Re-sync All the Organizations Information using SNS.

Request
Security:
bearer
Responses
200
post/api/organizations/re-sync-all
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/organizations/re-sync-all \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Organization Deleted Webhook API

Responses
200
post/api/integrations/apptivo/organizations-delete
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/organizations-delete
Response samples
application/json
{
  • "value": true
}

Organization Updated Webhook API

Responses
200
post/api/integrations/apptivo/organizations-update
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/organizations-update
Response samples
application/json
{
  • "value": true
}

Adds the Organization.

Request
Security:
bearer
Request Body schema: application/json
legacyIdentifier
string
parentId
string
type
required
string
hcoXrefId
string
businessName
required
string
displayName
required
string
object (IntegrationMetadataDto)
Array of objects (AddAddressDto)
Array of objects (AddPhoneNumberDto)
onBoardingPartnerId
string
originationSource
required
string
Enum: "CRM" "ADDI"
onBoardingStatus
number
Default: 1
    status: 1 indicates "Not Started",
    status: 2 indicates "Welcome Call",
    status: 3 indicates "Partner Education",
    status: 4 indicates "Completed",
organizationStatus
number
Default: 1
    status: 1 indicates "Contracted",
    status: 2 indicates "Active",
    status: 3 indicates "Suspended",
    status: 4 indicates "Separated"
rrmsSiteGroupId
string
signOnDate
string <date-time>
timezoneId
string
actionPlanCode
string
Responses
201
post/api/organizations
Request samples
application/json
{
  • "legacyIdentifier": "3f1ca924-2bf6-4780-acb1-61f71b71d1e2",
  • "parentId": "c0d67311-b0c5-4439-87a9-038cbb490091",
  • "type": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "addresses": [
    ],
  • "phoneNumbers": [
    ],
  • "onBoardingPartnerId": "6ba3d887-21e4-4d9b-9c9b-28cbd2482126",
  • "originationSource": "CRM",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "string",
  • "signOnDate": "2024-11-27T12:27:28.091Z",
  • "timezoneId": "string",
  • "actionPlanCode": "string"
}
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Lists all the available Organizations.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By : displayName or businessName

status
Array of strings

Default Value: [Active,Inactive,Suspended,Restored]

Items Enum: "Active" "Inactive" "Suspended" "Archived" "Restored"
sort_by
string

Default value : displayName

Example: sort_by=displayName
include
Array of strings

For query include=parent it returns parentOrganization with Organization,if exists

Items Enum: "parent" "children"
parentId
string
organizationIds
Array of strings

By adding the 'organizationIds' parameter to the API call, you can retrieve a list of Organizations information based on the specified IDs.

Responses
200
get/api/organizations
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations?order_by=ASC&skip=0&take=10&searchTerm=string&status=Active&sort_by=string&include=parent&parentId=string&organizationIds=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Syncs the Organization information into the CRM

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/crm-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/crm-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
include
Array of strings

For query include=parent it returns parentOrganization with Organization,if exists

Items Enum: "parent" "children"
Responses
200
get/api/organizations/{organizationId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}?include=parent' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Deletes the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
delete/api/organizations/{organizationId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Organization information by updating the items they were provided.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

Archives the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Suspend the Organization information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/suspend
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/suspend' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets Organization Hierarchy

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
mode
required
string
Enum: "flat" "nested"
searchTerm
string

Searched based on the Organization's Display Name or the Business Name

take
number
Default: 10
skip
number
Default: 0
Responses
200
get/api/organizations/{organizationId}/hierarchy
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/hierarchy?mode=flat&searchTerm=string&take=10&skip=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
OrganizationHierarchyDisplayModel
OrganizationHierarchyDisplayModel
{
  • "id": "6156ab96-b772-4306-8839-f1d3fea789af",
  • "businessName": "string",
  • "displayName": "string",
  • "status": "string",
  • "parentId": "string",
  • "level": 0,
  • "legacyIdentifier": "string",
  • "integrationMetadata": {
    },
  • "childOrganizations": [
    ]
}

Lists the Organization Ancestry Information(Parent Organizations Information) for the particular OrganizationId.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
searchTerm
string

Search By : displayName or businessName

status
Array of strings

Default Value: [Active,Inactive,Suspended,Restored]

Items Enum: "Active" "Inactive" "Suspended" "Archived" "Restored"
sort_by
string

Default value : displayName

Example: sort_by=displayName
include
Array of strings

For query include=parent it returns parentOrganization with Organization,if exists

Items Enum: "parent" "children"
organizationIds
Array of strings

By adding the 'organizationIds' parameter to the API call, you can retrieve a list of Organizations information based on the specified IDs.

Responses
200
get/api/organizations/{organizationId}/ancestries
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/ancestries?order_by=ASC&searchTerm=string&status=Active&sort_by=string&include=parent&organizationIds=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Updates Organization's Ancestry Nodes Information and Re-Syncs the Ancestry information into the Redis.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/ancestries/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/ancestries/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Updates Ancestry Nodes Information for all the Organizations and Re-Syncs the Ancestry information into the Redis. CRON - Every Week

Request
Security:
bearer
Responses
200
post/api/organizations/ancestries/re-sync-all
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/organizations/ancestries/re-sync-all \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Organization Audit Trails for given Organization Id.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/organizations/{organizationId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the on boarding Partner for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
get/api/organizations/{organizationId}/on-boarding-partners
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/on-boarding-partners' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "onBoardingPartner": {
    }
}

Deletes the on boarding Partner from Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
partnerId
required
string
Responses
200
delete/api/organizations/{organizationId}/on-boarding-partners/{partnerId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/on-boarding-partners/{partnerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds the on boarding Partner for Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
partnerId
required
string
Responses
200
post/api/organizations/{organizationId}/on-boarding-partners/{partnerId}
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/on-boarding-partners/{partnerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "onBoardingPartner": {
    }
}

Gets the Organization Setup Status information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
get/api/organizations/{organizationId}/setup-status
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/setup-status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Creates a new organization address

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
required
Array of objects (AddAddressDto)
Responses
200
201
post/api/organizations/{organizationId}/addresses
Request samples
application/json
{
  • "addresses": [
    ]
}
Response samples
application/json
{
  • "value": true
}

Lists the organization addresses

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
get/api/organizations/{organizationId}/addresses
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/addresses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

SeedData

List the organization types

Request
Security:
bearer
Responses
200
get/api/seed-data/organization-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/organization-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the organization status types

Request
Security:
bearer
Responses
200
get/api/seed-data/organization-status-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/organization-status-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the Subscriber status types

Request
Security:
bearer
Responses
200
get/api/seed-data/subscriber-status-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/subscriber-status-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the salutation types

Request
Security:
bearer
Responses
200
get/api/seed-data/salutation-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/salutation-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the Address types

Request
Security:
bearer
Responses
200
get/api/seed-data/address-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/address-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the Staff Member types

Request
Security:
bearer
Responses
200
get/api/seed-data/staff-member-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/staff-member-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List ECG Products.

Request
Security:
bearer
Responses
200
get/api/seed-data/ecg-products
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/ecg-products \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists the time zones

Request
Security:
bearer
Responses
200
get/api/seed-data/timezones
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/timezones \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the Apptivo Event Names

Request
Security:
bearer
Responses
200
get/api/seed-data/event-names
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/event-names \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List the Phone Types.

Request
Security:
bearer
Responses
200
get/api/seed-data/phone-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/phone-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists the Region Codes.

Request
Security:
bearer
Responses
200
get/api/seed-data/region-codes
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/region-codes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Country Codes.

Request
Security:
bearer
Responses
200
get/api/seed-data/country-codes
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/country-codes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available State Codes.

Request
Security:
bearer
query Parameters
countryCode
required
string
Example: countryCode=string
Responses
200
get/api/seed-data/state-codes
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/seed-data/state-codes?countryCode=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all of the available blood types.

Request
Security:
bearer
Responses
200
get/api/seed-data/blood-types
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/seed-data/blood-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Statistics

Lists all the available member statistics.

Request
Security:
bearer
Responses
200
get/api/member-statistics
Request samples
curl -i -X GET \
  https://orgs.ecg-api.com/api/member-statistics \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "organizations": {
    },
  • "subscribers": {
    },
  • "partners": {
    }
}

Lists all the available organization statistics.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
includeChildOrganizations
boolean
Responses
200
get/api/organizations/{organizationId}/member-statistics
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/member-statistics?includeChildOrganizations=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "organizations": {
    },
  • "subscribers": {
    },
  • "staffMembers": {
    }
}

ApptivoPayloads

Lists all the available Apptivo Payloads.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: errorMessage

status
string
Enum: "success" "failure"
eventName
string
Enum: "ecg.subscriber.created" "ecg.subscriber.updated" "ecg.subscriber.deleted" "ecg.partner.created" "ecg.partner.updated" "ecg.partner.deleted" "ecg.organization.created" "ecg.organization.updated" "ecg.organization.deleted"
sort_by
string

Default value : createdAt

Responses
200
get/api/apptivo-payloads
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/apptivo-payloads?order_by=ASC&skip=0&take=10&searchTerm=string&status=success&eventName=ecg.subscriber.created&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Users

Lists all the available Users

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, email or fullName(firstName+lastName).

roles
Array of strings

Filters based on the roles selected

Items Enum: "ecg-admin" "subscriber" "org-admin" "partner"
excludeRoles
Array of strings

Filters and Excludes the roles that are being selected

Items Enum: "ecg-admin" "subscriber" "org-admin" "partner"
personIds
Array of strings

Filters based on the person ids

organizationIds
Array of strings

Filters based on the organization ids

Responses
200
get/api/users
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/users?order_by=ASC&skip=0&take=10&searchTerm=string&roles=ecg-admin&excludeRoles=ecg-admin&personIds=string&organizationIds=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Account Audit Trails for all users

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/accounts/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/accounts/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Get's User account information based on PersonId or CognitoUserId.

Request
Security:
bearer
path Parameters
userId
required
string
query Parameters
type
required
string

Default value : local

Enum: "idp" "local"
include
Array of strings
Items Value: "permissions"
Responses
200
get/api/users/{userId}/accounts
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/users/{userId}/accounts?type=idp&include=permissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "email": "string",
  • "cognitoUserId": "ed708bd4-3f3b-48bb-91c4-867636c6c6ac",
  • "person": {
    },
  • "auditInfo": {
    },
  • "roles": [
    ],
  • "subscriber": {
    },
  • "ecgAdmin": {
    },
  • "orgAdmin": {
    },
  • "partner": {
    }
}

BackUp Cognito Users Information.

Request
Security:
bearer
Responses
200
post/api/users/backup
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/users/backup \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restore Cognito Users Information.

Request
Security:
bearer
Responses
200
post/api/users/restore
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/users/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Based on a user's email address, this API deletes their account information and removes them from cognito system

Request
Security:
bearer
Request Body schema: application/json
email
required
string
Responses
200
post/api/users/remove
Request samples
application/json
{
  • "email": "string@test.com"
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to delete the user information from the system

https://ecg.atlassian.net/wiki/spaces/ACM/pages/1996357722/STORY+-+Remove+User
Request
Security:
bearer
path Parameters
userId
required
string
query Parameters
type
required
string

Default value : local

Enum: "idp" "local"
Responses
200
delete/api/users/{userId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/users/{userId}?type=idp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

People

Resets User Password.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
password
string
isAutoGenerated
required
boolean
Responses
200
post/api/people/{personId}/reset-password
Request samples
application/json
{
  • "password": "string",
  • "isAutoGenerated": true
}
Response samples
application/json
{
  • "value": true
}

Resends the User Credentials

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/people/{personId}/resend-credentials
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/people/{personId}/resend-credentials' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds the Person Information.

Request
Security:
bearer
Request Body schema: application/json
object (AddAccountDto)
required
object (AddPersonDto)
Array of objects (AddAddressDto)
required
Array of objects (AddPhoneNumberDto)
Responses
201
post/api/people
Request samples
application/json
{
  • "account": {
    },
  • "person": {
    },
  • "addresses": [
    ],
  • "phoneNumbers": [
    ]
}
Response samples
application/json
{
  • "id": "4ccd115b-aac2-49d1-9082-bb0ff4120e0b",
  • "salutation": "1",
  • "firstName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "emailAddress": "string",
  • "party": {
    }
}

Adds the User account for a given Person.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
email
required
string
password
string
isAutoGenerated
required
boolean
Responses
201
post/api/people/{personId}/accounts
Request samples
application/json
{
  • "email": "string@gmail.com",
  • "password": "string",
  • "isAutoGenerated": true
}
Response samples
application/json
{
  • "email": "string",
  • "cognitoUserId": "ed708bd4-3f3b-48bb-91c4-867636c6c6ac",
  • "person": {
    },
  • "auditInfo": {
    }
}

Updates the User Account for a given Person. This API serves the purpose of updating the User Account Email Address and sets new password for the same.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
email
required
string
Responses
200
patch/api/people/{personId}/accounts
Request samples
application/json
{
  • "email": "string@test.com"
}
Response samples
application/json
{
  • "email": "string",
  • "cognitoUserId": "ed708bd4-3f3b-48bb-91c4-867636c6c6ac",
  • "person": {
    },
  • "auditInfo": {
    }
}

Gets the Person information by Id.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
get/api/people/{personId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/people/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "4ccd115b-aac2-49d1-9082-bb0ff4120e0b",
  • "salutation": "1",
  • "firstName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "emailAddress": "string",
  • "party": {
    }
}

Patches the Person information by updating the items.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/people/{personId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "4ccd115b-aac2-49d1-9082-bb0ff4120e0b",
  • "salutation": "1",
  • "firstName": "string",
  • "lastName": "string",
  • "suffix": "string",
  • "emailAddress": "string",
  • "party": {
    }
}

Changes Account Password for a given Person.

Request
path Parameters
personId
required
string
Request Body schema: application/json
previousPassword
required
string
proposedPassword
required
string
accessToken
required
string
Responses
200
post/api/people/{personId}/change-password
Request samples
application/json
{
  • "previousPassword": "string",
  • "proposedPassword": "string",
  • "accessToken": "string"
}
Response samples
application/json
{
  • "value": true
}

Re-sync single person's information

Request
Security:
bearer
query Parameters
id
required
string

PersonId or SubjectId(Bearer Token Sub)

type
required
string

Person or Sub

Enum: "person" "sub"
Responses
200
post/api/people/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/people/re-sync?id=string&type=person' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists available Account Audit Trails for given PersonId

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/people/{personId}/accounts/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/people/{personId}/accounts/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Re-sync person's information in batch of 100 person Ids

Request
Security:
bearer
Request Body schema: application/json
ids
required
Array of strings

Array of 100 PersonIds or SubjectIds(Bearer Token Sub)

Responses
200
202
post/api/people/re-sync-batch
Request samples
application/json
{
  • "ids": [
    ]
}
Response samples
application/json
{
  • "value": true
}

Staff-Members

Lists available Staff Member Audit Trails for all staffMembers

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/staff-members/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/staff-members/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Organization Block List Audit Trails for all staffMember

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/organization-block-lists/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organization-block-lists/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Staff Members.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName i.e. 'John Doe')

include
string

For query include=organization it returns Staff Member with organization ,if exists

Value: "organization"
sort_by
string

Default value : id

Example: sort_by=id
status
Array of strings
Items Enum: "restored" "archived" "active" "inactive"
includeParentStaff
string
Enum: "true" "false"
Responses
200
get/api/organizations/{organizationId}/staff-members
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members?order_by=ASC&skip=0&take=10&searchTerm=string&include=organization&sort_by=string&status=restored&includeParentStaff=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Staff Member.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
legacyIdentifier
string
isProvider
required
boolean
policies
Array of strings
memberType
required
number
personId
required
string
customPermissions
Array of strings
Responses
201
post/api/organizations/{organizationId}/staff-members
Request samples
application/json
{
  • "legacyIdentifier": "755c0844-0f97-478e-97c3-46a59d77d47f",
  • "isProvider": true,
  • "policies": [
    ],
  • "memberType": 1,
  • "personId": "77029df3-8662-4561-a81e-c776b27afc27",
  • "customPermissions": [
    ]
}
Response samples
application/json
{
  • "id": "cb7feb03-c7f4-469a-9fc4-2ffe9cdc653b",
  • "isProvider": "true",
  • "memberType": 1,
  • "person": {
    },
  • "organization": {
    },
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Lists all the designated ECG Admins and Staff Members based on the OrganizationID.

https://ecg.atlassian.net/wiki/spaces/ACM/pages/1988853761/STORY+-+Designated+Staff+Members+List
Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName i.e. 'John Doe')

includeParentStaff
string
Enum: "true" "false"
Responses
200
get/api/organizations/{organizationId}/designated-staff-members
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/designated-staff-members?skip=0&take=10&searchTerm=string&includeParentStaff=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Get the Staff Member for organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
query Parameters
include
string

For query include=organization it returns Staff Member with organization ,if exists

Value: "organization"
Responses
200
get/api/organizations/{organizationId}/staff-members/{personId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}?include=organization' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "cb7feb03-c7f4-469a-9fc4-2ffe9cdc653b",
  • "isProvider": "true",
  • "memberType": 1,
  • "person": {
    },
  • "organization": {
    },
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Patches the Staff Member information by updating the items.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/staff-members/{personId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "cb7feb03-c7f4-469a-9fc4-2ffe9cdc653b",
  • "isProvider": "true",
  • "memberType": 1,
  • "person": {
    },
  • "organization": {
    },
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Deletes the Staff Member information for an organization from the system, and will also remove the account information from cognito if any account information is associated for that staff member.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Responses
200
delete/api/organizations/{organizationId}/staff-members/{personId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Get the Staff Member by person Id

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
include
string

For query include=organization it returns Staff Member with organization ,if exists

Value: "organization"
Responses
200
get/api/staff-members/{personId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/staff-members/{personId}?include=organization' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "cb7feb03-c7f4-469a-9fc4-2ffe9cdc653b",
  • "isProvider": "true",
  • "memberType": 1,
  • "person": {
    },
  • "organization": {
    },
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Archive the Staff Member for organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restore the Staff Member for organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Staff Member for organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Staff Member for organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
personId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists available Staff Member Audit Trails for given personId

Request
Security:
bearer
path Parameters
personId
required
string
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/organizations/{organizationId}/staff-members/{personId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Organization Block List Audit Trails for given personId

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/staff-members/{personId}/organization-block-lists/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/staff-members/{personId}/organization-block-lists/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

List Blocked Organizations for Staff Member.

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName i.e. 'John Doe')

include
string

For query include=organization it returns Staff Member with organization ,if exists

Value: "organization"
sort_by
string

Default value : id

Example: sort_by=id
status
Array of strings
Items Enum: "restored" "archived" "active" "inactive"
includeParentStaff
string
Enum: "true" "false"
Responses
200
get/api/staff-members/{personId}/blocked-organizations
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/staff-members/{personId}/blocked-organizations?order_by=ASC&skip=0&take=10&searchTerm=string&include=organization&sort_by=string&status=restored&includeParentStaff=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Block Organization for Staff Member.

Request
Security:
bearer
path Parameters
personId
required
string
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/block
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/block' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Unblock Organization for Staff Member.

Request
Security:
bearer
path Parameters
personId
required
string
organizationId
required
string
Responses
200
post/api/organizations/{organizationId}/staff-members/{personId}/unblock
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/staff-members/{personId}/unblock' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets Staff Member Organization Hierarchy

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
mode
required
string
Enum: "flat" "nested"
Responses
200
get/api/staff-members/{personId}/organizations
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/staff-members/{personId}/organizations?mode=flat' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
NestedStaffHierarchyDisplayModel
NestedStaffHierarchyDisplayModel
{
  • "organization": {
    },
  • "assignment": "string"
}

Organization Transfer

The purpose of this API to transfer an organization from source parent organization to target parent organization.

Permissions needed - organization.transfer

Visit the confluence story for more information - OXREF | Organization Transfer API
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 42e7e348-ebb0-4c87-b068-b84cb3c743f9
Request Body schema: application/json
targetParentOrgId
string
transferType
required
string
Enum: "parent-to-parent" "standalone-to-parent" "parent-to-standalone"
scheduledAt
string
maxRetryCount
number

Number of total retry count if organization transfer process fails. Default: 3

Responses
200
post/api/v1/organization-transfers/{organizationId}/initiate
Request samples
application/json
{
  • "targetParentOrgId": "5dc93f9b-4bc5-49f4-aa0e-5ea80e1f7503",
  • "transferType": "parent-to-parent",
  • "scheduledAt": "2024-11-27T12:27:28.898Z",
  • "maxRetryCount": 3
}
Response samples
application/json
{
  • "id": "81b5fabf-31a4-49bc-a4c3-81930cc8ba5c",
  • "type": "string",
  • "status": "string",
  • "hcoXrefId": "string",
  • "businessName": "string",
  • "displayName": "string",
  • "integrationMetadata": {
    },
  • "nodes": [
    ],
  • "ancestryNodes": [
    ],
  • "originationSource": "string",
  • "onBoardingStatus": 1,
  • "organizationStatus": 1,
  • "rrmsSiteGroupId": "79d93ec0-7744-4d90-8895-273305311e29",
  • "timezoneId": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "party": {
    },
  • "signOnDate": "2024-11-27T12:27:28.100Z",
  • "actionPlanCode": "string",
  • "customerId": "string",
  • "parentOrganization": {
    },
  • "onBoardingPartner": "edeb8eb6-735b-4fcb-8e51-88c21f2ae1f4",
  • "childOrganizations": [
    ]
}

This API retrieves the count of impacted subscribers due to the organization transfer.

Permissions needed - organization.transfer

Visit the confluence story for more information - STORY - Retrieve Count of Impacted Subscribers
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 42e7e348-ebb0-4c87-b068-b84cb3c743f9
Responses
200
get/api/v1/organization-transfers/{organizationId}/impacted-subscribers/count
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/v1/organization-transfers/{organizationId}/impacted-subscribers/count' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "impactedSubscriberCount": {
    }
}

The purpose of this API to list all the available Organization Transfer history for organization based on query in paginated format.

Permissions needed - organization.transfer

Visit the confluence story for more information - STORY - List Single Organization Transfer History
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 7151e6ce-07e1-4a81-823e-6db3f5f14dd5
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

Responses
200
get/api/v1/organization-transfers/{organizationId}/histories
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/v1/organization-transfers/{organizationId}/histories?order_by=ASC&skip=0&take=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Subscribers

An Advanced Search for listing all the Subscribers

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName) of Subscriber

include
string

For query include=organization it returns subscribers with organizations,if exists

Value: "organization"
sort_by
string

Default value : firstName

Enum: "firstName" "lastName" "createdAt"
Example: sort_by=firstName
organizationId
string
nonPERS
boolean
subscriberIds
Array of strings

By adding the 'subscriberIds' parameter to the API call, you can retrieve a list of subscriber information based on the specified IDs.

xmitId
string

Subscribers information will be obtained from the device log using the XMIT Id, utilizing the codes for Anelto (anelto.pro-health-console) and Rapid (rapid.emergency-response).

subscriberStatus
Array of strings
Items Enum: "Under Review" "Active" "On Hold" "Cancelled" "Closed" "Created" "Anonymized" "Away" "Opt-Out" "Unenrolled"
contactId
string
actionPlanCode
string
mrnNumber
string
metadataKey
string
metadataValue
string
status
Array of strings
Items Enum: "restored" "archived" "active" "inactive"
Responses
200
get/api/subscribers/advanced-search
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/advanced-search?order_by=ASC&skip=0&take=10&searchTerm=string&include=organization&sort_by=firstName&organizationId=string&nonPERS=true&subscriberIds=string&xmitId=string&subscriberStatus=Under%20Review&contactId=string&actionPlanCode=string&mrnNumber=string&metadataKey=string&metadataValue=string&status=restored' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Syncs the Subscriber information into the CRM

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/crm-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/crm-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists available Subscriber Audit Trails for all Subscribers.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/subscribers/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Subscriber Access Rights Audit Trails for all subscriberAccess

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/subscribers/access-rights/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/access-rights/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Subscriber Created Webhook API

Responses
200
post/api/subscribers/integrations/apptivo/subscribers-create
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/subscribers/integrations/apptivo/subscribers-create
Response samples
application/json
{
  • "value": true
}

Subscriber updated Webhook API

Responses
200
post/api/subscribers/integrations/apptivo/subscribers-update
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/subscribers/integrations/apptivo/subscribers-update
Response samples
application/json
{
  • "value": true
}

Subscriber deleted Webhook API

Responses
200
post/api/subscribers/integrations/apptivo/subscribers-delete
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/subscribers/integrations/apptivo/subscribers-delete
Response samples
application/json
{
  • "value": true
}

Gets the Subscriber information by metadata.

Request
Security:
bearer
query Parameters
field
required
string
Example: field=string
value
required
string
Example: value=string
Responses
200
get/api/subscribers/metadata
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/metadata?field=string&value=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Adds the Policy Groups to Subscriber.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
policyGroupIds
required
Array of strings
Responses
200
post/api/subscribers/{personId}/policy-groups
Request samples
application/json
{
  • "policyGroupIds": [
    ]
}
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Patches the Subscriber Access information by updating the items they were provided.

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/subscribers/{personId}/access-rights/{subscriberAccessId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "fb1bd48f-7771-4149-8de6-865965e80189",
  • "blocked": false,
  • "policies": [
    ],
  • "subscriber": "f0446139-840b-498e-9d15-31467c636241",
  • "party": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Adds the Subscriber Access.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
legacyIdentifier
string
blocked
required
boolean
policies
Array of strings
required
Array of objects (AddAddressDto)
required
Array of objects (AddPhoneNumberDto)
Responses
201
post/api/subscribers/{personId}/access-rights
Request samples
application/json
{
  • "legacyIdentifier": "a4354ce7-48d4-4974-8982-bb2dc6f004ff",
  • "blocked": false,
  • "policies": [
    ],
  • "addresses": [
    ],
  • "phoneNumbers": [
    ]
}
Response samples
application/json
{
  • "id": "fb1bd48f-7771-4149-8de6-865965e80189",
  • "blocked": false,
  • "policies": [
    ],
  • "subscriber": "f0446139-840b-498e-9d15-31467c636241",
  • "party": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Archives the Subscriber Access information.

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
Responses
200
post/api/subscribers/{personId}/access-rights/{subscriberAccessId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/access-rights/{subscriberAccessId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Subscriber Access information.

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
Responses
200
post/api/subscribers/{personId}/access-rights/{subscriberAccessId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/access-rights/{subscriberAccessId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Subscriber Access information.

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
Responses
200
post/api/subscribers/{personId}/access-rights/{subscriberAccessId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/access-rights/{subscriberAccessId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Subscriber Access information.

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
Responses
200
post/api/subscribers/{personId}/access-rights/{subscriberAccessId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/access-rights/{subscriberAccessId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds the Subscriber.

Request
Security:
bearer
Request Body schema: application/json
organizationId
string
legacyIdentifier
string
object (AddAccountDto)
required
object (AddPersonDto)
status
number
Default: 2
    status: 1 indicates "Under Review",
    status: 2 indicates "Active",
    status: 3 indicates "On Hold",
    status: 4 indicates "Cancelled",
    status: 5 indicates "Closed",
    status: 6 indicates "Created",
    status: 8 indicates "Away",
primary
boolean
Default: true
partnerId
string
object (IntegrationMetadataDto)
nonPERS
boolean
Default: false
actionPlanCode
string
Responses
201
post/api/subscribers
Request samples
application/json
{
  • "organizationId": "4ad5d2d5-dfa4-4dc6-a542-85c821030ad0",
  • "legacyIdentifier": "d9332d71-16df-4cb5-a021-f03ac9f52f9a",
  • "account": {
    },
  • "person": {
    },
  • "status": 2,
  • "primary": true,
  • "partnerId": "109c1bfb-021e-427b-93f5-a9aebc4a3967",
  • "integrationMetadata": {
    },
  • "nonPERS": false,
  • "actionPlanCode": "string"
}
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Lists all the available Subscribers.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName) of Subscriber

include
string

For query include=organization it returns subscribers with organizations,if exists

Value: "organization"
sort_by
string

Default value : firstName

Enum: "firstName" "lastName" "createdAt"
Example: sort_by=firstName
organizationId
string
nonPERS
boolean
subscriberIds
Array of strings

By adding the 'subscriberIds' parameter to the API call, you can retrieve a list of subscriber information based on the specified IDs.

xmitId
string

Subscribers information will be obtained from the device log using the XMIT Id, utilizing the codes for Anelto (anelto.pro-health-console) and Rapid (rapid.emergency-response).

subscriberStatus
Array of strings
Items Enum: "Under Review" "Active" "On Hold" "Cancelled" "Closed" "Created" "Anonymized" "Away" "Opt-Out" "Unenrolled"
Responses
200
get/api/subscribers
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers?order_by=ASC&skip=0&take=10&searchTerm=string&include=organization&sort_by=firstName&organizationId=string&nonPERS=true&subscriberIds=string&xmitId=string&subscriberStatus=Under%20Review' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Subscriber By Id.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
organizationId
string
legacyIdentifier
string
status
number
Default: 2
    status: 1 indicates "Under Review",
    status: 2 indicates "Active",
    status: 3 indicates "On Hold",
    status: 4 indicates "Cancelled",
    status: 5 indicates "Closed",
    status: 6 indicates "Created",
    status: 8 indicates "Away",
primary
boolean
Default: true
partnerId
string
object (IntegrationMetadataDto)
nonPERS
boolean
Default: false
actionPlanCode
string
Responses
201
post/api/subscribers/{personId}
Request samples
application/json
{
  • "organizationId": "4ad5d2d5-dfa4-4dc6-a542-85c821030ad0",
  • "legacyIdentifier": "d9332d71-16df-4cb5-a021-f03ac9f52f9a",
  • "status": 2,
  • "primary": true,
  • "partnerId": "109c1bfb-021e-427b-93f5-a9aebc4a3967",
  • "integrationMetadata": {
    },
  • "nonPERS": false,
  • "actionPlanCode": "string"
}
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Gets the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
include
string

For query include=organization it returns subscribers with organizations,if exists

Value: "organization"
Responses
200
get/api/subscribers/{personId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}?include=organization' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string",
  • "account": {
    },
  • "products": "addison"
}

Deletes the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
delete/api/subscribers/{personId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/subscribers/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Subscriber information by updating the items they were provided.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/subscribers/{personId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Gets the Subscriber information by legacy Identifier.

Request
Security:
bearer
path Parameters
legacyIdentifier
required
string
query Parameters
include
string

For query include=organization it returns subscribers with organizations,if exists

Value: "organization"
Responses
200
get/api/subscribers/legacy-identifier/{legacyIdentifier}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/legacy-identifier/{legacyIdentifier}?include=organization' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string",
  • "account": {
    },
  • "products": "addison"
}

Archives the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activate the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the Subscriber information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists available Subscriber Audit Trails for given SubscriberId

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/subscribers/{personId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available devices for a given Subscriber

If active query param not passed both active & deactivated devices will be returned

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
active
boolean
Responses
200
get/api/subscribers/{personId}/devices
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/devices?active=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Subscriber Access Rights Audit Trails for given subscriberAccessId

Request
Security:
bearer
path Parameters
personId
required
string
subscriberAccessId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/subscribers/{personId}/access-rights/{subscriberAccessId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/access-rights/{subscriberAccessId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Subscriber metadata

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
Array
key
required
string
value
required
string
Responses
201
post/api/subscribers/{personId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Update subscriber's metadata

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/subscribers/{personId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "1750bf9b-f885-4b5f-ab89-5e4ffd8106b7",
  • "policies": [
    ],
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "organizationId": "91dc8390-968e-4f92-b851-ab856e42084d",
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "status": 1,
  • "nonPERS": false,
  • "actionPlanCode": "string",
  • "contactId": "string",
  • "mrnNumber": "string"
}

Delete the Subscriber's metadata

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
field
required
string
Example: field=string
Responses
200
delete/api/subscribers/{personId}/metadata
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/metadata?field=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Anonymize the Subscriber Information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/anonymize
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/anonymize' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Subscribers Profile

Creates a new subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
type
required
string

Subscriber type (HCO or Private)

Enum: "HCO" "Private"
required
object

Subscriber source information

organizationId
string

Organization Id

mrnNumber
string

Mrn Number

object

Subscriber personal information

object (HealthcareInformationDto)
Responses
201
post/subscribers-profile/{subscriberId}
Request samples
application/json
{
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "healthcareInformation": {
    }
}
Response samples
application/json
{
  • "id": "ba8feeb4-d349-4d8b-a160-7acd18fae655",
  • "version": "v1",
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "metadata": { },
  • "status": "Active",
  • "healthcareInformation": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Get Subscriber details

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
include
string
Enum: "both" "phoneNumber" "address"
Responses
200
get/subscribers-profile/{subscriberId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}?include=both' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "ba8feeb4-d349-4d8b-a160-7acd18fae655",
  • "version": "v1",
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "metadata": { },
  • "status": "Active",
  • "healthcareInformation": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Updates the subscriber information

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "ba8feeb4-d349-4d8b-a160-7acd18fae655",
  • "version": "v1",
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "metadata": { },
  • "status": "Active",
  • "healthcareInformation": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Deletes the subscriber information

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Responses
200
delete/subscribers-profile/{subscriberId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds the Subscriber metadata

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
Array
key
required
string
value
required
string
Responses
201
post/subscribers-profile/{subscriberId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "ba8feeb4-d349-4d8b-a160-7acd18fae655",
  • "version": "v1",
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "metadata": { },
  • "status": "Active",
  • "healthcareInformation": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Update a subscriber's metadata

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'replace' or 'remove'

  1. remove : Remove a property or array element.

  2. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/metadata
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "ba8feeb4-d349-4d8b-a160-7acd18fae655",
  • "version": "v1",
  • "type": "HCO",
  • "sourceInformation": {
    },
  • "organizationId": "f812566c-62db-4e52-a730-80af00c28fc7",
  • "mrnNumber": "1234j",
  • "personalInformation": {
    },
  • "metadata": { },
  • "status": "Active",
  • "healthcareInformation": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Delete a field from the Subscriber's metadata

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
field
required
any

metadata field to delete

Responses
200
delete/subscribers-profile/{subscriberId}/metadata
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/metadata' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Creates a new subscriber address

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
types
required
Array of strings

Address Types

Items Enum: "primary" "billing" "shipping"
required
object (AddAddressInfoDto)
lockBox
string
crossStreet
string
Responses
201
post/subscribers-profile/{subscriberId}/addresses
Request samples
application/json
{
  • "types": [
    ],
  • "address": {
    },
  • "lockBox": "'1234",
  • "crossStreet": "Main St"
}
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "version": "v1",
  • "addresses": [
    ]
}

Get subscriber addresses

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
type
string

Subscriber address type

Enum: "primary" "shipping" "billing"
Responses
200
get/subscribers-profile/{subscriberId}/addresses
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/addresses?type=primary' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "addresses": [
    ]
}

Get subscriber address by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

addressId
required
string

Address UUID

Responses
200
get/subscribers-profile/{subscriberId}/addresses/{addressId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/addresses/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "types": [
    ],
  • "address": {
    },
  • "lockBox": "1234",
  • "crossStreet": "Main St"
}

Deletes a subscriber address by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

addressId
required
string

Address UUID

Responses
200
delete/subscribers-profile/{subscriberId}/addresses/{addressId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/addresses/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Updates a subscriber address by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

addressId
required
string

Address UUID

Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/addresses/{addressId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "result": true
}

Creates a subscriber phone number

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
number
required
string

Phone number

extension
string

Extension

type
required
string

Phone type (Mobile, Home, Work, or Main)

Enum: "Mobile" "Home" "Work" "Main"
Responses
201
post/subscribers-profile/{subscriberId}/phone-numbers
Request samples
application/json
{
  • "number": "5055055050",
  • "extension": "333",
  • "type": "Mobile"
}
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "version": "v1",
  • "phoneNumbers": [
    ]
}

Gets subscriber phone numbers

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
type
string

Subscriber phone number type

Enum: "Mobile" "Home" "Work" "Main"
Responses
200
get/subscribers-profile/{subscriberId}/phone-numbers
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/phone-numbers?type=Mobile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
[
  • {
    }
]

Gets a subscriber phone number by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

phoneNumberId
required
string

Phone Number UUID

Responses
200
get/subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "number": "5055055050",
  • "extension": "333",
  • "type": "Mobile "
}

Deletes a subscriber phone number by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

phoneNumberId
required
string

Phone Number UUID

Responses
200
delete/subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Updates a subscriber phone number by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

phoneNumberId
required
string

Phone Number UUID

Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "result": true
}

Gets the Subscribers Call List

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
get/subscribers-profile/{subscriberId}/calls
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/calls' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "ecgSupport": {
    },
  • "pocketMD": {
    },
  • "rrms": {
    },
  • "responsibleParties": [
    ]
}

Reorders responsible parties' priorities

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
responsiblePartyId
required
string
priority
required
number
Responses
200
post/subscribers-profile/{subscriberId}/reorder-responsible-parties
Request samples
application/json
{
  • "responsiblePartyId": "33ba6925-c327-46f2-b371-c3f6555bfdeb",
  • "priority": 1
}
Response samples
application/json
[
  • {
    }
]

Creates responsible parties

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
Array
legacyIdentifier
string
required
object (AddRpPersonDto)
required
Array of objects (AddARpAddressDto)
required
Array of objects (AddRpPhoneNumberDto)
relationship
required
string
isKeyHolder
boolean
isNotifiedInEmergency
boolean
isPHIAuthorized
boolean
Responses
201
post/subscribers-profile/{subscriberId}/responsible-parties
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Lists all available responsible parties

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
searchTerm
string

Search By: firstName, lastName, or email

Enum: "firstName" "lastName" "email"
Example: searchTerm=email
include
string

For query include=subscriber it returns Responsible Parties with subscriber ,if exists

Value: "subscriber"
Example: include=subscriber
take
number

Number of records per page

Example: take=10
skip
number

Number of records to skip

sort_by
string
Enum: "id" "priority" "relationship" "activeStatusChangedAt" "archivedStatusChangedAt" "createdAt" "createdBy" "updatedAt" "updatedBy"
Example: sort_by=id
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
Responses
200
get/subscribers-profile/{subscriberId}/responsible-parties
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties?searchTerm=firstName&include=subscriber&take=0&skip=0&sort_by=id&order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
query Parameters
include
string

For query include=subscriber it returns Responsible Parties with subscriber, if exists

Value: "subscriber"
Responses
200
get/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}?include=subscriber' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "a3a2c2a8-d080-4b9a-9c20-f8967067b7fd",
  • "subscriber": { },
  • "relationship": "Mother",
  • "priority": 1,
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "isKeyHolder": true,
  • "isNotifiedInEmergency": true,
  • "isPHIAuthorized": true
}

Patches a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "a3a2c2a8-d080-4b9a-9c20-f8967067b7fd",
  • "subscriber": { },
  • "relationship": "Mother",
  • "priority": 1,
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "isKeyHolder": true,
  • "isNotifiedInEmergency": true,
  • "isPHIAuthorized": true
}

Deletes a Responsible Party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Responses
200
delete/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Patches a responsible party's phone numbers.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
phoneNumberId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers/{phoneNumberId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "a3a2c2a8-d080-4b9a-9c20-f8967067b7fd",
  • "subscriber": { },
  • "relationship": "Mother",
  • "priority": 1,
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "isKeyHolder": true,
  • "isNotifiedInEmergency": true,
  • "isPHIAuthorized": true
}

Deletes a Responsible Party Phone.

Delete a Responsible Party Phone

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
phoneNumberId
required
string
Responses
200
delete/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers/{phoneNumberId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers/{phoneNumberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Creates a Responsible Party Phone.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Request Body schema: application/json
number
required
string

Phone number

extension
string

Extension

type
required
string

Phone type (Mobile, Home, Work, or Main)

Enum: "Mobile" "Home" "Work" "Main"
Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers
Request samples
application/json
{
  • "number": "5055055050",
  • "extension": "333",
  • "type": "Mobile"
}
Response samples
application/json
{
  • "result": true
}

Patches a responsible party's addresses.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
addressId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses/{addressId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "a3a2c2a8-d080-4b9a-9c20-f8967067b7fd",
  • "subscriber": { },
  • "relationship": "Mother",
  • "priority": 1,
  • "person": {
    },
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "isKeyHolder": true,
  • "isNotifiedInEmergency": true,
  • "isPHIAuthorized": true
}

Deletes a Responsible Party Address.

Delete a Responsible Party Address

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
addressId
required
string
Responses
200
delete/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses/{addressId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses/{addressId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Creates a Responsible Party Address.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Request Body schema: application/json
addressLine1
required
string

Address Line 1

addressLine2
string

Address Line 2

addressLine3
string

Address Line 3

city
required
string

City

stateProvinceCode
required
string

State

postalCode
required
string

Zip

countryCode
string

Country

addressType
number

Address Type

Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses
Request samples
application/json
{
  • "addressLine1": "Address Line 1",
  • "addressLine2": "Address Line 2",
  • "addressLine3": "Address Line 3",
  • "city": "Las Cruces",
  • "stateProvinceCode": "NM",
  • "postalCode": "88011",
  • "countryCode": "US",
  • "addressType": 1
}
Response samples
application/json
{
  • "result": true
}

Archives a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates a responsible party.

Request
Security:
bearer
path Parameters
subscriberId
required
string
responsiblePartyId
required
string
Responses
200
post/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Assigns a blood type to a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
bloodType
required
string
Enum: "A+" "A-" "B+" "B-" "O+" "O-" "AB+" "AB-" "Unsure"
notes
string
Responses
201
post/subscribers-profile/{subscriberId}/blood-type
Request samples
application/json
{
  • "bloodType": "O-",
  • "notes": "universal donor"
}
Response samples
application/json
{
  • "bloodType": "O-",
  • "notes": "universal donor"
}

Get subscriber blood type by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Responses
200
get/subscribers-profile/{subscriberId}/blood-type
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/blood-type' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "bloodType": "O-",
  • "notes": "universal donor"
}

Updates subscriber blood type by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/blood-type
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "bloodType": "O-",
  • "notes": "universal donor"
}

creates a new subscriber medical condition

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
medicalCondtionId
required
string
notes
required
string
Responses
201

The record has been successfully created

post/subscribers-profile/{subscriberId}/medical-conditions
Request samples
application/json
{
  • "medicalCondtionId": "ed202f89-07f0-414d-a47b-3e4435a253b4",
  • "notes": "medical condition notes"
}
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "medicalCondition": {
    },
  • "notes": "medical condition notes",
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Retrieves all medical conditions for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

Responses
200
get/subscribers-profile/{subscriberId}/medical-conditions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-conditions?order_by=ASC&skip=0&take=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Retrieves a medical condition by Id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

conditionId
required
string

Medical Condition UUID

Responses
200
get/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "medicalCondition": {
    },
  • "notes": "medical condition notes",
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Updates subscriber medical condition

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

conditionId
required
string

Medical condition UUID

Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "bd2b81ba-b4ed-11eb-ad49-00155d334221",
  • "medicalCondition": {
    },
  • "notes": "medical condition notes",
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Archives subscriber medical condition

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

conditionId
required
string

Medical Condition UUID

Responses
200
post/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores subscriber medical condition

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

conditionId
required
string

Medical Condition UUID

Responses
200
post/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Retrieves all medical procedures for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

Responses
200
get/subscribers-profile/{subscriberId}/medical-procedures
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-procedures?order_by=ASC&skip=0&take=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Creates a new medical procedure for the subscriber's profile

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
name
required
string
procedureDate
required
string
notes
required
string
Responses
201

The record has been successfully created

post/subscribers-profile/{subscriberId}/medical-procedures
Request samples
application/json
{
  • "name": "CT Scan",
  • "procedureDate": "2022-02-09T22:35:08.482Z",
  • "notes": "Performed by DR. Lorem Ipsum"
}
Response samples
application/json
{
  • "id": "f7977d7b-7001-434b-b720-91f8d7a69f52",
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "name": "CT Scan",
  • "procedureDate": "2022-02-09T22:35:08.482Z",
  • "notes": "Performed by DR. Lorem Ipsum"
}

Retrieves a medical procedure by Id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

procedureId
required
string

Medical Procedure UUID

Responses
200
get/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "f7977d7b-7001-434b-b720-91f8d7a69f52",
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "name": "CT Scan",
  • "procedureDate": "2022-02-09T22:35:08.482Z",
  • "notes": "Performed by DR. Lorem Ipsum"
}

Updates subscriber medical procedure

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

procedureId
required
string

Medical Procedure UUID

Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "f7977d7b-7001-434b-b720-91f8d7a69f52",
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "name": "CT Scan",
  • "procedureDate": "2022-02-09T22:35:08.482Z",
  • "notes": "Performed by DR. Lorem Ipsum"
}

Archives subscriber medical procedure

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

procedureId
required
string

Medical Procedure UUID

Responses
200
post/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores subscriber medical procedure

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

procedureId
required
string

Medical Procedure UUID

Responses
200
post/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Creates a new medical allergy for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Request Body schema: application/json
medicalAllergyId
required
string
notes
string
Responses
201
post/subscriber-profile/{subscriberId}/medical-allergies
Request samples
application/json
{
  • "medicalAllergyId": "d621e321-20c2-4b72-8a56-dcdf177865a5",
  • "notes": "Delayed response"
}
Response samples
application/json
{
  • "id": "2c51e811-1e31-4ab9-b238-3f68973e413f",
  • "notes": "Delayed response",
  • "medicalAllergy": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Lists medical allergies for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

Responses
200
get/subscriber-profile/{subscriberId}/medical-allergies
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscriber-profile/{subscriberId}/medical-allergies?order_by=ASC&skip=0&take=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets a medical allergy for a subscriber by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

allergyId
required
string

Medical allergy UUID

Responses
200
get/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "2c51e811-1e31-4ab9-b238-3f68973e413f",
  • "notes": "Delayed response",
  • "medicalAllergy": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Updates a medical allergy for a subscriber by id

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

allergyId
required
string

Medical allergy UUID

Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "2c51e811-1e31-4ab9-b238-3f68973e413f",
  • "notes": "Delayed response",
  • "medicalAllergy": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Archives a medical allergy for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

allergyId
required
string

Medical allergy UUID

Responses
200
post/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores a medical allergy for a subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

allergyId
required
string

Medical allergy UUID

Responses
200
post/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

EcgAdmins

Lists available ECG Admin Audit Trails for all the ECG Admins.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/ecg-admins/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/ecg-admins/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Patches the ECG Admin information by updating the items.

Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/ecg-admins/{personId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "9fc45f15-cc46-4428-8a5e-ab93dfd04fdb",
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "activeInfo": {
    },
  • "person": {
    }
}

Get the ECG Admin by Id.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
get/api/ecg-admins/{personId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/ecg-admins/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "9fc45f15-cc46-4428-8a5e-ab93dfd04fdb",
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "activeInfo": {
    },
  • "person": {
    }
}

Lists all the available ECG Admin.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName, contactEmailAddress or fullName(firstName+lastName).

Responses
200
get/api/ecg-admins
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/ecg-admins?order_by=ASC&skip=0&take=10&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the ECG Admin.

Request
Security:
bearer
Request Body schema: application/json
legacyIdentifier
string
policies
Array of strings
required
object (AddPersonDto)
object (AddAccountDto)
required
Array of objects (AddAddressDto)
required
Array of objects (AddPhoneNumberDto)
customPermissions
Array of strings
Responses
201
post/api/ecg-admins
Request samples
application/json
{
  • "legacyIdentifier": "c45509c8-1014-4057-8f65-1c7e6fc41af9",
  • "policies": [
    ],
  • "person": {
    },
  • "account": {
    },
  • "addresses": [
    ],
  • "phoneNumbers": [
    ],
  • "customPermissions": [
    ]
}
Response samples
application/json
{
  • "id": "9fc45f15-cc46-4428-8a5e-ab93dfd04fdb",
  • "policies": [
    ],
  • "customPermissions": [
    ],
  • "activeInfo": {
    },
  • "person": {
    }
}

Activate the ECG Admin information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/ecg-admins/{personId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/ecg-admins/{personId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate the ECG Admin information.

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/ecg-admins/{personId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/ecg-admins/{personId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available ECG Admin Audit Trails for given ECG Admin Id.

Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/ecg-admins/{personId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/ecg-admins/{personId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Partners

Lists available Partner Audit Trails for all partners.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partners/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partners/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Partners.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

include
string

For query include=parentPartner it returns partner with parentPartner ,if exists

Enum: "subscribers" "parentPartner" "subsidiaries"
Responses
200
get/api/partners
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partners?order_by=ASC&skip=0&take=10&include=subscribers' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Add the Partner.

Request
Security:
bearer
Request Body schema: application/json
legacyIdentifier
string
allowSubscriberAccess
boolean
object (AddPersonDto)
object (AddAccountDto)
object (AddOrganizationDto)
parentId
string
partnerType
required
string
required
Array of objects (AddAddressDto)
required
Array of objects (AddPhoneNumberDto)
object (IntegrationMetadataDto)
signOnDate
string <date-time>
Responses
201
post/api/partners
Request samples
application/json
{
  • "legacyIdentifier": "42d6fefc-a964-441e-877f-4f5bab89b38d",
  • "allowSubscriberAccess": false,
  • "person": {
    },
  • "account": {
    },
  • "organization": {
    },
  • "parentId": "2fcceabd-56aa-465c-aba3-09a208a46e8f",
  • "partnerType": "ffc3bfc0-8a2c-42dc-bd2b-d93023d20f7d",
  • "addresses": [
    ],
  • "phoneNumbers": [
    ],
  • "integrationMetadata": {
    },
  • "signOnDate": "2024-11-27T12:27:28.121Z"
}
Response samples
application/json
{
  • "id": "6ec43f2f-4fbf-4bd8-9060-0994c65d31c2",
  • "partnerType": {
    },
  • "party": {
    },
  • "allowSubscriberAccess": false,
  • "subscribers": [
    ],
  • "person": {
    },
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "signOnDate": "2024-11-27T12:27:28.135Z",
  • "customerId": "string",
  • "parentPartner": {
    },
  • "subsidiaries": [
    ]
}

Get the Partner by Id.

Request
Security:
bearer
path Parameters
partnerId
required
string
query Parameters
include
string

For query include=parentPartner it returns partner with parentPartner ,if exists

Enum: "subscribers" "parentPartner" "subsidiaries"
Responses
200
get/api/partners/{partnerId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partners/{partnerId}?include=subscribers' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "6ec43f2f-4fbf-4bd8-9060-0994c65d31c2",
  • "partnerType": {
    },
  • "party": {
    },
  • "allowSubscriberAccess": false,
  • "subscribers": [
    ],
  • "person": {
    },
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "signOnDate": "2024-11-27T12:27:28.135Z",
  • "customerId": "string",
  • "parentPartner": {
    },
  • "subsidiaries": [
    ]
}

Patches the Partner information by updating the items.

Request
Security:
bearer
path Parameters
partnerId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/partners/{partnerId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "6ec43f2f-4fbf-4bd8-9060-0994c65d31c2",
  • "partnerType": {
    },
  • "party": {
    },
  • "allowSubscriberAccess": false,
  • "subscribers": [
    ],
  • "person": {
    },
  • "organization": {
    },
  • "integrationMetadata": {
    },
  • "signOnDate": "2024-11-27T12:27:28.135Z",
  • "customerId": "string",
  • "parentPartner": {
    },
  • "subsidiaries": [
    ]
}

Partner Created Webhook API

Responses
200
post/api/integrations/apptivo/partners-create
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/partners-create
Response samples
application/json
{
  • "value": true
}

Partner Deleted Webhook API

Responses
200
post/api/integrations/apptivo/partners-delete
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/partners-delete
Response samples
application/json
{
  • "value": true
}

Partner Updated Webhook API

Responses
200
post/api/integrations/apptivo/partners-update
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/integrations/apptivo/partners-update
Response samples
application/json
{
  • "value": true
}

Lists available Partner Audit Trails for given partnerId.

Request
Security:
bearer
path Parameters
partnerId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partners/{partnerId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partners/{partnerId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Syncs the Partner information in CRM

Request
Security:
bearer
path Parameters
partnerId
required
string
Responses
200
post/api/partners/{partnerId}/crm-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/partners/{partnerId}/crm-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Manages to Sync the customerId information from the Partner's legacy-identifier. Please Note this endpoint is for testing purpose only and will be removed shortly.

Request
Security:
bearer
Responses
200
post/api/partners/sync/customerId
Request samples
curl -i -X POST \
  https://orgs.ecg-api.com/api/partners/sync/customerId \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

PartnerTypes

Lists available Partner Type Rule Audit Trails for all.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/children/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/children/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Partner Direct Commissions Audit Trails for all.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/direct-commissions/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/direct-commissions/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists Partner Indirect Commissions Audit Trails for all.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/indirect-commissions/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/indirect-commissions/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Partner Type Audit Trails for all the Partner Types.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Partner type.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
description
string
apptivoValueId
string
directPayout
required
boolean
successLadderBonus
string
Responses
201
post/api/partner-types
Request samples
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string | null",
  • "apptivoValueId": "string",
  • "directPayout": false,
  • "successLadderBonus": "5ff34d19-3de1-46bd-980d-84b5d5c3fecc"
}
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Lists all the available Partner Types.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: name, code or description

sort_by
string

Default value : id

Example: sort_by=id
Responses
200
get/api/partner-types
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types?order_by=ASC&skip=0&take=10&searchTerm=string&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Partner Type Information.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
query Parameters
include
string

For query include=successLadderBonus it returns partner-type with successLadderBonus,if exists

Enum: "parent" "children" "successLadderBonus"
Responses
200
get/api/partner-types/{partnerTypeId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}?include=parent' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Deletes the Partner Type Information.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
delete/api/partner-types/{partnerTypeId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Partner Type information by updating the items they were provided.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/partner-types/{partnerTypeId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Activates the Partner Type information.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
post/api/partner-types/{partnerTypeId}/activate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Partner Type information.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
post/api/partner-types/{partnerTypeId}/deactivate
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Partner Type Children.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
get/api/partner-types/{partnerTypeId}/children
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/children' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Partner Type Children.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json
childPartnerTypeIds
required
Array of strings
Responses
201
post/api/partner-types/{partnerTypeId}/children
Request samples
application/json
{
  • "childPartnerTypeIds": [
    ]
}
Response samples
application/json
null

Deletes the Partner Type Child.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
childrenId
required
string
Responses
200
delete/api/partner-types/{partnerTypeId}/children/{childrenId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/children/{childrenId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Partner Type Indirect Commissions

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
childrenId
required
string
Responses
200
get/api/partner-types/{partnerTypeId}/children/{childrenId}/indirect-commissions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/children/{childrenId}/indirect-commissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "14819e79-2ce9-4c6e-a7bc-15d13030179b",
  • "parentPartnerType": "eba158a1-7eed-4250-8cce-d831160f2eae",
  • "childPartnerType": {
    },
  • "productId": "ade08566-440e-4fdc-be9a-51286fd119fa",
  • "recurringCommissionAmount": 0,
  • "oneTimeCommissionAmount": 0
}

Gets the Partner Type Commission.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
commissionId
required
string
Responses
200
get/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "e9c18f1c-22a6-4913-a459-a83b3b2fab87",
  • "productId": "d9c5ff60-0301-4e48-904d-6c97ad5f5e12",
  • "partnerType": {
    },
  • "isOneTimeCommission": false,
  • "isRecurringCommission": false,
  • "recurringCommissionAmount": 0,
  • "oneTimeCommissionAmount": 0
}

Patches the Partner Type Commission information by updating the items they were provided.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
commissionId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "e9c18f1c-22a6-4913-a459-a83b3b2fab87",
  • "productId": "d9c5ff60-0301-4e48-904d-6c97ad5f5e12",
  • "partnerType": {
    },
  • "isOneTimeCommission": false,
  • "isRecurringCommission": false,
  • "recurringCommissionAmount": 0,
  • "oneTimeCommissionAmount": 0
}

Deletes the Partner Type Commission information.

Request
Security:
bearer
path Parameters
commissionId
required
string
partnerTypeId
required
string
Responses
200
delete/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds the Partner Type Commission.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json
productId
required
string
required
object (Commission)
required
object (Commission)
Responses
201
post/api/partner-types/{partnerTypeId}/direct-commissions
Request samples
application/json
{
  • "productId": "e3d41dd7-776a-4de6-b5c9-5ef2a729280e",
  • "oneTimeCommission": {
    },
  • "recurringCommission": {
    }
}
Response samples
application/json
{
  • "id": "e9c18f1c-22a6-4913-a459-a83b3b2fab87",
  • "productId": "d9c5ff60-0301-4e48-904d-6c97ad5f5e12",
  • "partnerType": {
    },
  • "isOneTimeCommission": false,
  • "isRecurringCommission": false,
  • "recurringCommissionAmount": 0,
  • "oneTimeCommissionAmount": 0
}

Lists all the available Partner Type Direct Commissions

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
query Parameters
productId
any

For filtering all the Direct Commissions of a Particular Product

Responses
200
get/api/partner-types/{partnerTypeId}/direct-commissions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/direct-commissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Partner Type Indirect Commissions

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
get/api/partner-types/{partnerTypeId}/indirect-commissions
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/indirect-commissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Partner Type Audit Trails for given Partner Type Id.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/{partnerTypeId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists available Partner Type Rule Audit Trails for given Id.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/{partnerTypeId}/children/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/children/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists all the available Partner Direct Commissions Audit Trails for given Id.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
commissionId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Lists Partner Indirect Commissions Audit Trails for given Id

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
commissionId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/partner-types/{partnerTypeId}/indirect-commissions/{commissionId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/indirect-commissions/{commissionId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Assign Success Ladder Bonus

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json
successLadderBonus
required
string
Responses
201
post/api/partner-types/{partnerTypeId}/success-ladder-bonuses
Request samples
application/json
{
  • "successLadderBonus": "384d87b8-914e-4bef-baa7-e4c725ffacb3"
}
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Gets the Success Ladder Bonus information for a given Partner Type.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
get/api/partner-types/{partnerTypeId}/success-ladder-bonuses
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/success-ladder-bonuses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "0680bdd0-db5d-4d45-9218-be41aae1cdba",
  • "title": "string",
  • "description": "string",
  • "currencyCode": "string",
  • "tiers": [
    ],
  • "auditInfo": {
    }
}

Patch for the Success Ladder Bonus information from a Partner Type

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/partner-types/{partnerTypeId}/success-ladder-bonuses
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

Adds HCO Commission for the Partner type.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json
hcoCommission
required
number
Responses
200
post/api/partner-types/{partnerTypeId}/hco-commissions
Request samples
application/json
{
  • "hcoCommission": 0
}
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Patches HCO Commission information by updating the items they were provided.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/partner-types/{partnerTypeId}/hco-commissions
Request samples
application/json
{
  • "value": "new_value",
  • "path": "/path",
  • "op": "replace"
}
Response samples
application/json
{
  • "id": "cdfbf6c1-be09-46bf-8a8f-038b578456bb",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "apptivoValueId": "string",
  • "hcoCommission": 0,
  • "activeInfo": {
    },
  • "directPayout": false,
  • "successLadderBonus": {
    },
  • "hasSLB": true
}

Deletes HCO Commission information for the Partner type.

Request
Security:
bearer
path Parameters
partnerTypeId
required
string
Responses
200
delete/api/partner-types/{partnerTypeId}/hco-commissions
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/partner-types/{partnerTypeId}/hco-commissions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

SuccessLadderBonuses

Lists available Success Ladder Bonus Audit Trails for all.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/success-ladder-bonuses/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/success-ladder-bonuses/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds Success Ladder Information.

Request
Security:
bearer
Request Body schema: application/json
title
required
string
description
string
currencyCode
required
string
required
Array of objects (AddTiersDto)
Responses
201
post/api/success-ladder-bonuses
Request samples
application/json
{
  • "title": "string",
  • "description": "string",
  • "currencyCode": "string",
  • "tiers": [
    ]
}
Response samples
application/json
{
  • "id": "0680bdd0-db5d-4d45-9218-be41aae1cdba",
  • "title": "string",
  • "description": "string",
  • "currencyCode": "string",
  • "tiers": [
    ],
  • "auditInfo": {
    }
}

Lists all the available Success Ladder Bonuses.

Request
Security:
bearer
query Parameters
order_by
string

Default value : DESC

Enum: "ASC" "DESC"
Example: order_by=DESC
searchTerm
any

Search By: title or description

Responses
200
get/api/success-ladder-bonuses
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/success-ladder-bonuses?order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
[
  • {
    }
]

Patches the Success Ladder Bonus information by updating the items they were provided.

Request
Security:
bearer
path Parameters
successLadderBonusId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/success-ladder-bonuses/{successLadderBonusId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "0680bdd0-db5d-4d45-9218-be41aae1cdba",
  • "title": "string",
  • "description": "string",
  • "currencyCode": "string",
  • "tiers": [
    ],
  • "auditInfo": {
    }
}

Lists available Success Ladder Bonus Audit Trails for given Id

Request
Security:
bearer
path Parameters
successLadderBonusId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/success-ladder-bonuses/{successLadderBonusId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/success-ladder-bonuses/{successLadderBonusId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

PolicyGroups

Lists available Policy Group Audit Trails for all the Policy Groups.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/policy-groups/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policy-groups/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Patches the Policy Group information by updating the items.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Request Body schema: application/json

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/policy-groups/{policyGroupId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "62d97ce6-9b57-41e7-b3e4-ce21a23d3f28",
  • "title": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "policies": [
    ]
}

Get the Policy Group by Id.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
query Parameters
include
string

For query include=policies it returns policy-group with policies

Value: "policies"
Responses
200
get/api/policy-groups/{policyGroupId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policy-groups/{policyGroupId}?include=policies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "62d97ce6-9b57-41e7-b3e4-ce21a23d3f28",
  • "title": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "policies": [
    ]
}

Deletes the Policy Group information.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Responses
200
delete/api/policy-groups/{policyGroupId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/policy-groups/{policyGroupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Policy Group.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: title, code or description

include
string

For query include=policies it returns policy-group with policies

Value: "policies"
sort_by
string

Default value : id

Example: sort_by=id
Responses
200
get/api/policy-groups
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policy-groups?order_by=ASC&skip=0&take=10&searchTerm=string&include=policies&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the Policy Group.

Request
Security:
bearer
Request Body schema: application/json
title
required
string
code
required
string
description
string
policies
required
Array of strings
Responses
201
post/api/policy-groups
Request samples
application/json
{
  • "title": "string",
  • "code": "string",
  • "description": "string | null",
  • "policies": [
    ]
}
Response samples
application/json
{
  • "id": "62d97ce6-9b57-41e7-b3e4-ce21a23d3f28",
  • "title": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "policies": [
    ]
}

Deletes Policies from Policy Group.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Request Body schema: application/json
policyIds
required
Array of strings
Responses
200
delete/api/policy-groups/{policyGroupId}/policies
Request samples
application/json
{
  • "policyIds": [
    ]
}
Response samples
application/json
{
  • "value": true
}

Adds Policies to Policy Group.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Request Body schema: application/json
policyIds
required
Array of strings
Responses
200
post/api/policy-groups/{policyGroupId}/policies
Request samples
application/json
{
  • "policyIds": [
    ]
}
Response samples
application/json
{
  • "id": "62d97ce6-9b57-41e7-b3e4-ce21a23d3f28",
  • "title": "string",
  • "code": "string",
  • "description": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "policies": [
    ]
}

Archives the Policy Group information.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Responses
200
post/api/policy-groups/{policyGroupId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policy-groups/{policyGroupId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Policy Group information.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
Responses
200
post/api/policy-groups/{policyGroupId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/policy-groups/{policyGroupId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Policy Group Audit Trails for given Policy Group Id.

Request
Security:
bearer
path Parameters
policyGroupId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

sort_by
string

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTerm
string

Search By: action

Enum: "UPDATE" "DELETE" "INSERT"
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>
Example: from=2024-11-27T12:27:28.797Z
to
string <date-time>
Example: to=2024-11-27T12:27:28.797Z
Responses
200
get/api/policy-groups/{policyGroupId}/audit-trails
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/policy-groups/{policyGroupId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=string&searchTerm=UPDATE&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Anelto Credentials

Adds the Anelto Credentials for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
aneltoUsername
required
string
aneltoPassword
required
string
Responses
201
post/api/organizations/{organizationId}/anelto-credentials
Request samples
application/json
{
  • "aneltoUsername": "string",
  • "aneltoPassword": "string"
}
Response samples
application/json
{
  • "aneltoUsername": "string",
  • "aneltoPasswordReference": "string",
  • "secretsManagerArn": "string",
  • "auditInfo": {
    }
}

Gets the Anelto Credentials for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
get/api/organizations/{organizationId}/anelto-credentials
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/anelto-credentials' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "aneltoUsername": "string",
  • "aneltoPasswordReference": "string",
  • "secretsManagerArn": "string",
  • "auditInfo": {
    }
}

Patches the Anelto Credentials for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
aneltoUsername
required
string
aneltoPassword
required
string
Responses
200
patch/api/organizations/{organizationId}/anelto-credentials
Request samples
application/json
{
  • "aneltoUsername": "string",
  • "aneltoPassword": "string"
}
Response samples
application/json
{
  • "aneltoUsername": "string",
  • "aneltoPasswordReference": "string",
  • "secretsManagerArn": "string",
  • "auditInfo": {
    }
}

Subscriber Devices

Gets device logs by product type or provisioning attribute

Request
Security:
bearer
query Parameters
provisioningAttribute
required
string
provisioningAttributeValue
required
string
Responses
200
get/api/subscriber-devices
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscriber-devices?provisioningAttribute=string&provisioningAttributeValue=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Retires a device

Request
Security:
bearer
path Parameters
deviceId
required
string
Responses
200
patch/api/subscriber-devices/{deviceId}/retire
Request samples
curl -i -X PATCH \
  'https://orgs.ecg-api.com/api/subscriber-devices/{deviceId}/retire' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "a77840da-6f33-4f93-a245-b132c46d533b",
  • "subscriberId": "b602b190-de40-430b-b0b6-31e1b9465975",
  • "organizationId": "caaae83f-4a35-4d54-99f5-a1e870f04c5f",
  • "orderId": "62880022075fb6accd9c2afc",
  • "orderLineItemId": "62880022075fb6accd9c2afc",
  • "productType": "anelto-hub",
  • "primaryAttribute": "ANZ0000",
  • "provisionedAttributes": {
    },
  • "effectiveFrom": "2020-01-01 06:30:00",
  • "effectiveTo": "2021-01-02 06:30:00",
  • "orderType": 1,
  • "active": false,
  • "auditFields": {
    }
}

Gets subscribers associated with devices matching the provided provisioning attribute or product type

Request
Security:
bearer
query Parameters
include
string

For query include=organization it returns subscribers with organizations,if exists

Value: "organization"
provisioningAttribute
required
string
provisioningAttributeValue
required
string
Responses
200
get/api/subscriber-devices/subscriber
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscriber-devices/subscriber?include=organization&provisioningAttribute=string&provisioningAttributeValue=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Client Credentials

Adds the Client Credentials for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
personId
required
string
Responses
201
post/api/organizations/{organizationId}/client-credentials
Request samples
application/json
{
  • "personId": "f6293edb-da0e-4cf2-abcb-2017ec924a59"
}
Response samples
application/json
{
  • "person": {
    },
  • "organization": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "clientId": "string"
}

Lists the Client Credentials Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName or contactEmailAddress

Responses
200
get/api/organizations/{organizationId}/client-credentials
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials?order_by=ASC&skip=0&take=10&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Client Credentials Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
clientId
required
string
Example: string
Responses
200
get/api/organizations/{organizationId}/client-credentials/{clientId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials/{clientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "person": {
    },
  • "organization": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "clientId": "string",
  • "clientSecret": "string"
}

Deletes the Client Credentials Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
clientId
required
string
Example: string
Responses
200
delete/api/organizations/{organizationId}/client-credentials/{clientId}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials/{clientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

ReSyncs the Client Credentials Information for an Organization in ACM.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
clientId
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/client-credentials/{clientId}/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials/{clientId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Archives the Client Credentials information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
clientId
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/client-credentials/{clientId}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials/{clientId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Client Credential information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
clientId
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/client-credentials/{clientId}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/client-credentials/{clientId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists the Api Keys Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: firstName, lastName or contactEmailAddress

Responses
200
get/api/organizations/{organizationId}/api-keys
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys?order_by=ASC&skip=0&take=10&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Adds the ApiKey Credentials for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
apiKey
required
string
personId
required
string
Responses
201
post/api/organizations/{organizationId}/api-keys
Request samples
application/json
{
  • "apiKey": "string",
  • "personId": "5da78b4a-9a53-47cb-b89d-df899cb2d678"
}
Response samples
application/json
{
  • "person": {
    },
  • "organization": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "apiKey": "string"
}

Gets the ApiKey Credentials Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
apiKey
required
string
Example: string
Responses
200
get/api/organizations/{organizationId}/api-keys/{apiKey}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys/{apiKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "person": {
    },
  • "organization": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "apiKey": "string"
}

Deletes the ApiKey Credentials Information for an Organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
apiKey
required
string
Example: string
Responses
200
delete/api/organizations/{organizationId}/api-keys/{apiKey}
Request samples
curl -i -X DELETE \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys/{apiKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

ReSyncs the ApiKey Credentials Information for an Organization in ACM.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
apiKey
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/api-keys/{apiKey}/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys/{apiKey}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Archives the Api Key information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
apiKey
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/api-keys/{apiKey}/archive
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys/{apiKey}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Api Key information.

Request
Security:
bearer
path Parameters
organizationId
required
string
Example: uuid
apiKey
required
string
Example: string
Responses
200
post/api/organizations/{organizationId}/api-keys/{apiKey}/restore
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/api-keys/{apiKey}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Subscriber Transfer

The purpose of this API to transfer subscriber from source organization to target organization.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | API SPECIFICATIONS
Request
Security:
bearer
path Parameters
personId
required
string
Request Body schema: application/json
targetOrgId
required
string
scheduledAt
string
Array of objects
Responses
200
put/api/subscribers/{personId}/transfers
Request samples
application/json
{
  • "targetOrgId": "bf68332e-15f3-419d-b0b4-e6c4aca0689c",
  • "scheduledAt": "2024-11-27T12:27:29.612Z",
  • "orderInfo": [
    ]
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API to list the transfer subscriber history for subscriber.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | API SPECIFICATIONS
Request
Security:
bearer
path Parameters
personId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 25

Number of Records per page, Default value : 25

organizationId
string
Responses
200
get/api/subscribers/{personId}/transfers
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/transfers?order_by=ASC&skip=0&take=25&organizationId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API to re-sync the process of transfer subscriber from source organization to target organization.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | API SPECIFICATIONS
Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
post/api/subscribers/{personId}/transfers/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/transfers/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

This API endpoint is designed to provide the status of a subscriber transfer operation identified by the personId

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | Single Transfer API Enhancements
Request
Security:
bearer
path Parameters
personId
required
string
Example: b73847d5-83e5-464c-9188-0b35343ac19a
Responses
200
get/api/subscribers/{personId}/transfers/status
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscribers/{personId}/transfers/status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "b4d775b3-8985-4a92-86f4-34f0041bb2ad",
  • "personId": "096e5502-ba9a-4b52-a0a5-e3b3b232d391",
  • "message": "string",
  • "progressPercentage": 10,
  • "status": "IN-PROGRESS",
  • "eventId": "string",
  • "error": {
    },
  • "completedAt": "string"
}

The purpose of this API to Lists available Subscriber Transfer Activity.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | API SPECIFICATIONS
Request
Security:
bearer
query Parameters
subscriberId
string
sourceOrgId
string
targetOrgId
string
subscriberOrganizationHistoryId
string
status
string
Enum: "IN-PROGRESS" "SUCCESS" "FAILURE"
batchId
string
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 25

Number of Records per page, Default value : 25

Responses
200
get/api/subscriber-transfer-activities
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/subscriber-transfer-activities?subscriberId=string&sourceOrgId=string&targetOrgId=string&subscriberOrganizationHistoryId=string&status=IN-PROGRESS&batchId=string&skip=0&take=25' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Batch Subscriber Transfers

This API endpoint facilitates the initiation of a batch subscriber transfer operation, allowing users to transfer multiple subscribers in a single request.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | Batch Transfer API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: c08ee34c-8786-4713-961a-7fcd6b5340cf
Request Body schema: application/json
targetOrgId
required
string
scheduledAt
string
required
Array of objects (TransferInfoDto)
Responses
201
post/api/organizations/{organizationId}/batch-transfers
Request samples
application/json
{
  • "targetOrgId": "ac13c5f3-25c0-4b94-af9a-5016279b9a32",
  • "scheduledAt": "2024-11-27T12:27:29.604Z",
  • "transferInfo": [
    ]
}
Response samples
application/json
{
  • "id": "c1f393e9-d7ee-46c4-bae6-2b8387024c0e",
  • "sourceOrganization": {
    },
  • "targetOrganization": {
    },
  • "subscribers": [
    ],
  • "scheduledAt": "2024-11-27T12:27:29.606Z",
  • "auditInfo": {
    }
}

The purpose of this API to fetch information about batch subscriber transfers for a specific organization.

Permissions needed - subscribers.read

Visit the confluence story for more information - XREF | Batch Transfer API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: c08ee34c-8786-4713-961a-7fcd6b5340cf
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 25

Number of Records per page, Default value : 25

batchId
string
Example: batchId=95c033ee-624c-4fd9-a8ba-15ff07b10639
subscriberId
string
Example: subscriberId=301b64fb-344a-4d19-a8ba-98f2eb3b63d3
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2024-11-27T12:27:29.602Z
to
string
Example: to=2024-11-27T12:27:29.602Z
include
Array of strings
Items Enum: "source-org" "target-org" "subscriber"
Responses
200
get/api/organizations/{organizationId}/batch-transfers
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/batch-transfers?order_by=ASC&skip=0&take=25&batchId=string&subscriberId=string&dateRangeType=custom&from=string&to=string&include=source-org' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API to re-sync subscriber transfers with a status of failure for a specific batch within an organization.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | Batch Transfer API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: c08ee34c-8786-4713-961a-7fcd6b5340cf
batchId
required
string
Example: 0272bf53-33d7-49ec-8ce9-928eec419f20
Responses
200
post/api/organizations/{organizationId}/batch-transfers/{batchId}/re-sync
Request samples
curl -i -X POST \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/batch-transfers/{batchId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to retrieve details for a specific batch subscriber transfer within an organization.

Permissions needed - subscribers.read

Visit the confluence story for more information - XREF | Batch Transfer API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: c08ee34c-8786-4713-961a-7fcd6b5340cf
batchId
required
string
Example: 0272bf53-33d7-49ec-8ce9-928eec419f20
query Parameters
include
Array of strings
Items Enum: "source-org" "target-org" "subscriber"
Responses
200
get/api/organizations/{organizationId}/batch-transfers/{batchId}
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/batch-transfers/{batchId}?include=source-org' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "c1f393e9-d7ee-46c4-bae6-2b8387024c0e",
  • "sourceOrganization": {
    },
  • "targetOrganization": {
    },
  • "subscribers": [
    ],
  • "scheduledAt": "2024-11-27T12:27:29.606Z",
  • "auditInfo": {
    }
}

The purpose of this API to provide the status details of a specific batch transfer within an organization. It allows you to include subscriber information in the response.

Permissions needed - subscribers.admin

Visit the confluence story for more information - XREF | Batch Transfer API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: c08ee34c-8786-4713-961a-7fcd6b5340cf
batchId
required
string
Example: 0272bf53-33d7-49ec-8ce9-928eec419f20
query Parameters
include
Array of strings
Items Value: "subscriber"
Responses
200
get/api/organizations/{organizationId}/batch-transfers/{batchId}/status
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/batch-transfers/{batchId}/status?include=subscriber' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "items": [
    ],
  • "total": 1
}

Subscriber Status Change Histories

Retrieve the status change history for a specific subscriber, listing the records in ascending order of changed_at timestamp.

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - STORY - SUBCNCL | Create Subscriber Status Change History
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 59ac3d62-75c7-4636-9a64-56951b2f0ded
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

subscriberId
string
Example: subscriberId=694d696f-88d2-495f-80d8-c72d4e6e8fa2
Responses
200
get/api/organizations/{organizationId}/status-histories
Request samples
curl -i -X GET \
  'https://orgs.ecg-api.com/api/organizations/{organizationId}/status-histories?order_by=ASC&skip=0&take=10&subscriberId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null