Team—Get Team

This API allows a user to get a copy of the Team object. The Team object contains the configuration information for a specific team, which includes the URI, the team ID, the team name, and a list of agents who are members of that team.

URI:

http://<FQDN>/finesse/api/Team/<id>

Example URI:

http://finesse1.xyz.com/finesse/api/Team/10

Security Constraints:

Supervisors can use this API to get a list of users assigned to their team.

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

401: Authorization Failure

404: Not Found

500: Internal Server Error

Example Response:

<Team>
   <uri>/finesse/api/Team/34</uri>
   <id>34</id>
   <name>My Team</name>
   <users>
      <User>
         <uri>/finesse/api/User/1234/</uri>
         <loginId>1234</loginId>
         <firstName>Charles</firstName>
         <lastName>Brown</lastName>
         <dialogs>/finesse/api/User/1234/Dialogs</dialogs>
         <extension>1001001</extension>
         <pendingState></pendingState>
         <state>LOGOUT</state>
         <stateChangeTime>2012-03-01T17:58:21.345Z</stateChangeTime>
      </User>
      <User>
         <uri>/finesse/api/User/1235/</uri>
         <loginId>1235</loginId>
         <firstName>Jack</firstName>
         <lastName>Brawn</lastName>
         <dialogs>/finesse/api/User/1235/Dialogs</dialogs>
         <extension>1001002</extension>
         <pendingState></pendingState>
         <state>NOT_READY</state>
         <reasonCode>
            <category>NOT_READY</category>
            <code>12</code>
            <label>Lunch Break</label>
            <id>1</id>
            <uri>/finesse/api/ReasonCode/1</uri>
         </reasonCode> 
         <stateChangeTime>2012-03-01T18:22:25.123Z</stateChangeTime>
      </User>
      ...Other Users...
   </users>
</Team>          
 

Example Failure Response:

<ApiErrors>
     <ApiError>
          <ErrorType>Authorization Failure</ErrorType>
          <ErrorMessage>UNAUTHORIZED</ErrorMessage>
          <ErrorData>jsmith</ErrorData>
   </ApiError>
</ApiErrors>