api-docs v5.116.0

API Docs

Table of contents

Organization_Partner

Organization Partner - Delete

Back to top

Delete a specific organization partner

DELETE /organization-partners/:id

Headers - Header

Name Type Description
Authorization string

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

Header examples

Authorization-Example

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

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
type string Allowed values: diagnostic-sendout
organization string
partner string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Organization Partner - Find

Back to top

Get list of organization partners

GET /organization-partners

Headers - Header

Name Type Description
Authorization string

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

Header examples

Authorization-Example

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

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
organizationPartners object[]

array of organizationPartner
organizationPartners.id string
organizationPartners.createdAt number

timestamp
organizationPartners.createdBy string

account uid
organizationPartners.type string Allowed values: diagnostic-sendout
organizationPartners.organization string
organizationPartners.partner string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Organization Partner - Get

Back to top

Get a specific organization partner

GET /organization-partners/:id

Headers - Header

Name Type Description
Authorization string

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

Header examples

Authorization-Example

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

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
type string Allowed values: diagnostic-sendout
organization string
partner string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Organization Partner - Patch

Back to top

Update organization partner

PATCH /organization-partners/:id

Headers - Header

Name Type Description
Authorization string

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

Header examples

Authorization-Example

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

Parameters - Parameter

Name Type Description
createdAt string optional

timestamp

Examples

Example usage:

curl "https://yourdomain.com/organization-partners/<organization-partner-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "createdAt": 1234567890
  }'

Parameters examples

json - Request-Example

{
  "createdAt": 1234567890
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
type string Allowed values: diagnostic-sendout
organization string
partner string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Organization Partner - Post

Back to top

Create organization partner

POST /organization-partners

Headers - Header

Name Type Description
Authorization string

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

Header examples

Authorization-Example

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

Parameters - Parameter

Name Type Description
type string Allowed values: diagnostic-sendout
organization string
partner string
createdAt string optional

timestamp

Examples

Example usage:

curl "https://yourdomain.com/organization-partners" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "diagnostic-sendout",
    "organization": "org-id",
    "partner": "partner-id"
  }'

Parameters examples

json - Request-Example

{
  "type": "diagnostic-sendout",
  "organization": "org-id",
  "partner": "partner-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
type string Allowed values: diagnostic-sendout
organization string
partner string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""