GET api/EngagementOverview?clientId={clientId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of EngagementOverview
NameDescriptionTypeAdditional information
queued_Count

integer

None.

scheduled_Count

integer

None.

inProgress_Count

integer

None.

onHold_Count

integer

None.

completed_Count

integer

None.

queued_Color

string

None.

scheduled_Color

string

None.

inPro_Color

string

None.

onHold_Color

string

None.

completed_Color

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "queued_Count": 1,
    "scheduled_Count": 2,
    "inProgress_Count": 3,
    "onHold_Count": 4,
    "completed_Count": 5,
    "queued_Color": "sample string 6",
    "scheduled_Color": "sample string 7",
    "inPro_Color": "sample string 8",
    "onHold_Color": "sample string 9",
    "completed_Color": "sample string 10"
  },
  {
    "queued_Count": 1,
    "scheduled_Count": 2,
    "inProgress_Count": 3,
    "onHold_Count": 4,
    "completed_Count": 5,
    "queued_Color": "sample string 6",
    "scheduled_Color": "sample string 7",
    "inPro_Color": "sample string 8",
    "onHold_Color": "sample string 9",
    "completed_Color": "sample string 10"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEngagementOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <EngagementOverview>
    <completed_Color>sample string 10</completed_Color>
    <completed_Count>5</completed_Count>
    <inPro_Color>sample string 8</inPro_Color>
    <inProgress_Count>3</inProgress_Count>
    <onHold_Color>sample string 9</onHold_Color>
    <onHold_Count>4</onHold_Count>
    <queued_Color>sample string 6</queued_Color>
    <queued_Count>1</queued_Count>
    <scheduled_Color>sample string 7</scheduled_Color>
    <scheduled_Count>2</scheduled_Count>
  </EngagementOverview>
  <EngagementOverview>
    <completed_Color>sample string 10</completed_Color>
    <completed_Count>5</completed_Count>
    <inPro_Color>sample string 8</inPro_Color>
    <inProgress_Count>3</inProgress_Count>
    <onHold_Color>sample string 9</onHold_Color>
    <onHold_Count>4</onHold_Count>
    <queued_Color>sample string 6</queued_Color>
    <queued_Count>1</queued_Count>
    <scheduled_Color>sample string 7</scheduled_Color>
    <scheduled_Count>2</scheduled_Count>
  </EngagementOverview>
</ArrayOfEngagementOverview>