GET api/agency/teams?pageSize={pageSize}&pageNumber={pageNumber}&teamType={teamType}

Returns a list of team groups for the agency. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

The page size value supplied with the request.

integer

Default value is 20

pageNumber

The page number value supplied with the request.

integer

Default value is 1

teamType

The team type value supplied with the request.

string

None.

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfAgencyTeamListDataContract
NameDescriptionTypeAdditional information
TotalCount

The total count value.

integer

None.

CurrentCount

The current count value.

integer

None.

PageSize

The page size value.

integer

None.

PageNumber

The page number value.

integer

None.

Collection

The collection of collection.

Collection of AgencyTeamListDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Name": "sample string 1",
      "TeamType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Responsibilities": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "Members": [
        {
          "JobTitle": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TeamRelationshipType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Note": "sample string 5",
          "ContactName": "sample string 6",
          "Id": 7
        },
        {
          "JobTitle": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TeamRelationshipType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Note": "sample string 5",
          "ContactName": "sample string 6",
          "Id": 7
        }
      ],
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "TeamType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Responsibilities": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "Members": [
        {
          "JobTitle": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TeamRelationshipType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Note": "sample string 5",
          "ContactName": "sample string 6",
          "Id": 7
        },
        {
          "JobTitle": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TeamRelationshipType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Note": "sample string 5",
          "ContactName": "sample string 6",
          "Id": 7
        }
      ],
      "Id": 2
    }
  ]
}