POST api/list/teams?pageSize={pageSize}&pageNumber={pageNumber}

Teams. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional 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

Body Parameters

The team list filter data contract supplied with the request.

TeamListFilterDataContract

Name	Description	Type	Additional information
TeamType	The team type value.	string	None.
Name	The name value.	string	None.
CustomFilterConfig	The custom filter config value.	string	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
EventBranchIds	The unique identifiers of the related event branch resources.	Collection of integer	None.
Order	The order classification.	ListOrder	None.
SearchTerm	The search term value.	string	None.
FilterType	The filter type value.	EnumDataContract	None.
ShowDeleted	Indicates whether show deleted is true.	boolean	None.
ShowCancelled	Indicates whether show cancelled is true.	boolean	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "TeamType": "sample string 1",
  "Name": "sample string 2",
  "CustomFilterConfig": "sample string 3",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 4",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 7,
  "Id": 8
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfTeamListDataContract

Name	Description	Type	Additional 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 TeamListDataContract	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
    }
  ]
}