GET api/V2/team/PlayerGroup/{companyId}

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of TeamPlayerGroup

Name	Type	Additional information
GroupId	integer	None.
CompanyId	globally unique identifier	None.
GroupName	string	None.
GroupCoach	string	None.
GroupComments	string	None.
ShowOnArrangementPage	boolean	None.
UsersInPlayerGroup	Collection of UsersInPlayerGroup	None.
Selected	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "groupId": 1,
    "companyId": "73a99bd9-4d19-430b-b534-f5f407474dd2",
    "groupName": "sample string 3",
    "groupCoach": "sample string 4",
    "groupComments": "sample string 5",
    "showOnArrangementPage": true,
    "usersInPlayerGroup": [
      {
        "id": 1,
        "groupId": 2,
        "userId": "4be45b2b-4e94-48a5-a201-c1ef302b0e9c",
        "userName": "sample string 4",
        "isCoach": true
      },
      {
        "id": 1,
        "groupId": 2,
        "userId": "4be45b2b-4e94-48a5-a201-c1ef302b0e9c",
        "userName": "sample string 4",
        "isCoach": true
      }
    ],
    "selected": true
  },
  {
    "groupId": 1,
    "companyId": "73a99bd9-4d19-430b-b534-f5f407474dd2",
    "groupName": "sample string 3",
    "groupCoach": "sample string 4",
    "groupComments": "sample string 5",
    "showOnArrangementPage": true,
    "usersInPlayerGroup": [
      {
        "id": 1,
        "groupId": 2,
        "userId": "4be45b2b-4e94-48a5-a201-c1ef302b0e9c",
        "userName": "sample string 4",
        "isCoach": true
      },
      {
        "id": 1,
        "groupId": 2,
        "userId": "4be45b2b-4e94-48a5-a201-c1ef302b0e9c",
        "userName": "sample string 4",
        "isCoach": true
      }
    ],
    "selected": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfTeamPlayerGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/oiback.Classes">
  <TeamPlayerGroup>
    <CompanyId>73a99bd9-4d19-430b-b534-f5f407474dd2</CompanyId>
    <GroupCoach>sample string 4</GroupCoach>
    <GroupComments>sample string 5</GroupComments>
    <GroupId>1</GroupId>
    <GroupName>sample string 3</GroupName>
    <Selected>true</Selected>
    <ShowOnArrangementPage>true</ShowOnArrangementPage>
    <UsersInPlayerGroup>
      <UsersInPlayerGroup>
        <GroupId>2</GroupId>
        <Id>1</Id>
        <IsCoach>true</IsCoach>
        <UserId>4be45b2b-4e94-48a5-a201-c1ef302b0e9c</UserId>
        <UserName>sample string 4</UserName>
      </UsersInPlayerGroup>
      <UsersInPlayerGroup>
        <GroupId>2</GroupId>
        <Id>1</Id>
        <IsCoach>true</IsCoach>
        <UserId>4be45b2b-4e94-48a5-a201-c1ef302b0e9c</UserId>
        <UserName>sample string 4</UserName>
      </UsersInPlayerGroup>
    </UsersInPlayerGroup>
  </TeamPlayerGroup>
  <TeamPlayerGroup>
    <CompanyId>73a99bd9-4d19-430b-b534-f5f407474dd2</CompanyId>
    <GroupCoach>sample string 4</GroupCoach>
    <GroupComments>sample string 5</GroupComments>
    <GroupId>1</GroupId>
    <GroupName>sample string 3</GroupName>
    <Selected>true</Selected>
    <ShowOnArrangementPage>true</ShowOnArrangementPage>
    <UsersInPlayerGroup>
      <UsersInPlayerGroup>
        <GroupId>2</GroupId>
        <Id>1</Id>
        <IsCoach>true</IsCoach>
        <UserId>4be45b2b-4e94-48a5-a201-c1ef302b0e9c</UserId>
        <UserName>sample string 4</UserName>
      </UsersInPlayerGroup>
      <UsersInPlayerGroup>
        <GroupId>2</GroupId>
        <Id>1</Id>
        <IsCoach>true</IsCoach>
        <UserId>4be45b2b-4e94-48a5-a201-c1ef302b0e9c</UserId>
        <UserName>sample string 4</UserName>
      </UsersInPlayerGroup>
    </UsersInPlayerGroup>
  </TeamPlayerGroup>
</ArrayOfTeamPlayerGroup>