GET api/v3/customers/projects/{projectId}
Retrieves details about a specific project for a customer
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| projectId |
The id of the project to retrieve information for |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A structure describing the project.
CustomerProjectInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| ProjectId |
The id of the project |
integer |
None. |
| ProjectNumber |
Number of the project |
string |
None. |
| ProjectName |
Name of the project |
string |
None. |
| OverridePricingId |
Identifier of the pricing sheet that should be used with this project |
integer |
None. |
| OverridePricingNo |
Number of the pricing sheet that should be used with this project |
string |
None. |
| OverridePricingName |
Name of the pricing sheet that should be used with this project |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"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:
<CustomerProjectInformation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <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>