Engagement Types

Description

The endpoint retrieves the list of engagement types.


HTTP Method

get


URL

/api/engagementtypes/{languageID}

Path Parameters

Name Type
languageID

required <integer>

Default value : 1


Query Parameters

Name Type
includeInactive

optional <boolean>

Default value : false
api-version optional <string>


Response

[
  {
    "ID": 0,
    "DisplayText": "string",
    "IsActive": true,
    "DisplayOrder": 0
  }
]

Example

[
    {
        "ID": 0,
        "DisplayText": "In-Person",
        "IsActive": true,
        "DisplayOrder": 1
    },
    {
        "ID": 83,
        "DisplayText": "Hybryd",
        "IsActive": true,
        "DisplayOrder": 2
    },
    {
        "ID": 70,
        "DisplayText": "Virtual",
        "IsActive": true,
        "DisplayOrder": 3
    }
]

Success Response

Code: 200 OK