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

BaseListFilterDataContract
NameDescriptionTypeAdditional information
Name

string

None.

CustomFilterConfig

string

None.

BranchId

integer

None.

BranchIds

Collection of integer

None.

EventBranchIds

Collection of integer

None.

Order

ListOrder

None.

SearchTerm

string

None.

FilterType

EnumDataContract

None.

ShowDeleted

boolean

None.

ShowCancelled

boolean

None.

OwningTeamId

integer

None.

Id

integer

None.

Request Formats

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
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BaseListFilterDataContract'.

Response Information

Resource Description

PagedCollectionDataContractOfNegotiatorListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of NegotiatorListDataContract

None.

Response Formats

application/json, text/json

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