POST api/list/teams?pageSize={pageSize}&pageNumber={pageNumber}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageSize | integer |
Default value is 20 |
|
pageNumber | integer |
Default value is 1 |
Body Parameters
Dezrez.Core.DataContracts.External.Api.Lists.Groups.Filter.TeamListFilterDataContractName | Description | Type | Additional information |
---|---|---|---|
TeamType | string |
None. |
|
Name | string |
None. |
|
CustomFilterConfig | string |
None. |
|
BranchId | integer |
None. |
|
BranchIds | Collection of integer |
None. |
|
EventBranchIds | Collection of integer |
None. |
|
Order | Dezrez.Core.DataContracts.External.Api.Lists.ListOrder |
None. |
|
SearchTerm | string |
None. |
|
FilterType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
ShowDeleted | boolean |
None. |
|
ShowCancelled | boolean |
None. |
|
OwningTeamId | integer |
None. |
|
Id | 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
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Groups.TeamListDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.Lists.Groups.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 } ] }