POST api/v3/customers/{customerId}/projectList

Retrieves a filtered list of projects for a customer.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	The id for the requested customer.	integer	Required

Body Parameters

The parameters defining the requested items.

CustomerProjectSearchRequest

Name	Description	Type	Additional information
FilterText	The text to match to either location name or code.	string	None.
MatchPartial	Allow partial match	boolean	Default value is false
StartingRowNumber	Starting row number	integer	Default value is 0
RowCount	Maximum number of rows to return.	integer	Default value is 50

Request Formats

application/json, text/json

Sample:

{
  "FilterText": "sample string 1",
  "MatchPartial": true,
  "StartingRowNumber": 3,
  "RowCount": 4
}

application/xml, text/xml

Sample:

<CustomerProjectSearchRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FilterText>sample string 1</FilterText>
  <MatchPartial>true</MatchPartial>
  <StartingRowNumber>3</StartingRowNumber>
  <RowCount>4</RowCount>
</CustomerProjectSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A structure representing the found projects for the customer per the request parameters.

CustomerProjectSearchResponse

Name	Description	Type	Additional information
RecordCount	Total count of records that match the criteria in the look up request.	integer	None.
CustomerHasProjectList	Indicates if the customer has a project list in the system.	boolean	None.
Projects	An array of projects matching the search criteria.	Collection of CustomerProjectInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "RecordCount": 1,
  "CustomerHasProjectList": true,
  "Projects": [
    {
      "ProjectId": 1,
      "ProjectNumber": "sample string 2",
      "ProjectName": "sample string 3",
      "OverridePricingId": 1,
      "OverridePricingNo": "sample string 4",
      "OverridePricingName": "sample string 5"
    },
    {
      "ProjectId": 1,
      "ProjectNumber": "sample string 2",
      "ProjectName": "sample string 3",
      "OverridePricingId": 1,
      "OverridePricingNo": "sample string 4",
      "OverridePricingName": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<CustomerProjectSearchResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <RecordCount>1</RecordCount>
  <CustomerHasProjectList>true</CustomerHasProjectList>
  <Projects>
    <CustomerProjectInformation>
      <ProjectId>1</ProjectId>
      <ProjectNumber>sample string 2</ProjectNumber>
      <ProjectName>sample string 3</ProjectName>
      <OverridePricingId>1</OverridePricingId>
      <OverridePricingNo>sample string 4</OverridePricingNo>
      <OverridePricingName>sample string 5</OverridePricingName>
    </CustomerProjectInformation>
    <CustomerProjectInformation>
      <ProjectId>1</ProjectId>
      <ProjectNumber>sample string 2</ProjectNumber>
      <ProjectName>sample string 3</ProjectName>
      <OverridePricingId>1</OverridePricingId>
      <OverridePricingNo>sample string 4</OverridePricingNo>
      <OverridePricingName>sample string 5</OverridePricingName>
    </CustomerProjectInformation>
  </Projects>
</CustomerProjectSearchResponse>