POST api/list/pm/companies

Returns a list of companies in PM

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmCompaniesListFilterDataContract

Name	Type	Additional information
TeamGroupIds	Collection of integer	None.
BranchIds	Collection of integer	None.
IncludeArchived	boolean	None.
CompanyTypes	Collection of string	None.
PageSize	integer	None.
PageNumber	integer	None.
Term	string	None.
OrderByDescending	boolean	None.
Name	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "TeamGroupIds": [
    1,
    2
  ],
  "BranchIds": [
    1,
    2
  ],
  "IncludeArchived": true,
  "CompanyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 2",
  "OrderByDescending": true,
  "Name": "sample string 3"
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Company.CompanyListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of Dezrez.Core.DataContracts.External.Api.Lists.Company.CompanyListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "GroupId": 1,
      "Name": "sample string 2",
      "Email": "sample string 3",
      "EmailMarketingStatus": "sample string 4",
      "Telephone": "sample string 5",
      "TelephoneMarketingStatus": "sample string 6",
      "CompanyType": "sample string 7"
    },
    {
      "GroupId": 1,
      "Name": "sample string 2",
      "Email": "sample string 3",
      "EmailMarketingStatus": "sample string 4",
      "Telephone": "sample string 5",
      "TelephoneMarketingStatus": "sample string 6",
      "CompanyType": "sample string 7"
    }
  ]
}