POST api/Agents

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TerminalID	integer	None.
SysWorkGroupTeamIDs	Collection of integer	None.
UserType	UserType	None.

Request Formats

application/json, text/json

Sample:

{
  "TerminalID": 1,
  "SysWorkGroupTeamIDs": [
    1,
    2
  ],
  "UserType": 0
}

application/xml, text/xml

Sample:

<ApiAgentsViewModel.GetAgentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <SysWorkGroupTeamIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SysWorkGroupTeamIDs>
  <TerminalID>1</TerminalID>
  <UserType>All</UserType>
</ApiAgentsViewModel.GetAgentsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AgentsItem

Name	Type	Additional information
UserID	globally unique identifier	None.
FirstName	string	None.
LastName	string	None.
Nickname	string	None.
PicturePath	string	None.
Position	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserID": "eb396289-5200-47ff-8218-e96b31510504",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Nickname": "sample string 4",
    "PicturePath": "sample string 5",
    "Position": "sample string 6"
  },
  {
    "UserID": "eb396289-5200-47ff-8218-e96b31510504",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Nickname": "sample string 4",
    "PicturePath": "sample string 5",
    "Position": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiAgentsViewModel.AgentsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <ApiAgentsViewModel.AgentsItem>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <Nickname>sample string 4</Nickname>
    <PicturePath>sample string 5</PicturePath>
    <Position>sample string 6</Position>
    <UserID>eb396289-5200-47ff-8218-e96b31510504</UserID>
  </ApiAgentsViewModel.AgentsItem>
  <ApiAgentsViewModel.AgentsItem>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <Nickname>sample string 4</Nickname>
    <PicturePath>sample string 5</PicturePath>
    <Position>sample string 6</Position>
    <UserID>eb396289-5200-47ff-8218-e96b31510504</UserID>
  </ApiAgentsViewModel.AgentsItem>
</ArrayOfApiAgentsViewModel.AgentsItem>