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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.BaseListFilterDataContract
NameDescriptionTypeAdditional information
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:
{
  "Name": "sample string 1",
  "CustomFilterConfig": "sample string 2",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 3",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 6,
  "Id": 7
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Negotiators.NegotiatorListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Negotiators.NegotiatorListDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "JobTitle": "sample string 1",
      "Title": "sample string 2",
      "ContactName": "sample string 3",
      "ClaimedTasks": [
        1,
        2
      ],
      "Biography": "sample string 4",
      "EmailAddress": "sample string 5",
      "TelephoneNumber": "sample string 6",
      "TeamGroupId": 7,
      "Id": 8
    },
    {
      "JobTitle": "sample string 1",
      "Title": "sample string 2",
      "ContactName": "sample string 3",
      "ClaimedTasks": [
        1,
        2
      ],
      "Biography": "sample string 4",
      "EmailAddress": "sample string 5",
      "TelephoneNumber": "sample string 6",
      "TeamGroupId": 7,
      "Id": 8
    }
  ]
}