...
This web service retrieves a list of cost cener center summary records (PwsCostCenterSummary), based on specified search criteria. You may also explicitly retrieve a summary of an explicitly specified cost center (PwsCostCenterRef).
| Note |
|---|
Unlike most other services that retrieve summary lists from Projector, you will likely need to specify at least one of the "Include" flags if you are not using the service to retrieve a single summary. If you so not specify one of the flags on the request, you are likely to have an empty result set returned. |
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | ARKG+qjBuMq+YMu7gEYnoA== | ||
CostCenterIdentity | No | For this service, the caller may specify up to 1 a cost center identity. If a cost center identity is not specified all clients fitting the other specified criteria will be returned. Click here for more information. | |||
IncludeAncestorsFlag | Boolean | No | false | If set to 'true', the ancestors (i.e. parent, grandparents, grandparentetc.) of the returned cost center(s) will also be returned whether or not they fit the search criteria. Otherwise, only the specified cost center or the cost centers matching the specified criteria will be returned. | false |
IncludeEngagementCostCentersFlag | Boolean | No | false | If set to 'true', only cost centers enabled for engagements will be returnedincluded in the response (as long as they meet the remaining criteria). This flag is disregarded if a cost center is specified. | true |
IncludeInactiveFlag | Boolean | No | false | If set to 'true', all cost centers including those that have been marked as inactive will be returned. This flag is disregarded if a cost center is specified. | true |
IncludeResourceCostCentersFlag | Boolean | No | false | If set to 'true', only cost centers enabled for resources will be returnedbe included in the response (as long as they meet the remaining criteria). This flag is disregarded if a cost center is specified. | true |
String (255) | No | The cost centers that are returned will contain the value in this field. This flag A search string to narrow down the results. A cost center will be included in the results if the search string matches the cost center number or cost center name, or if it is a child to a cost center that is matched based upon the criteria. This value is disregarded if a cost center is specified in CostCenterIdentity. | |||
IncludeNonResourceNonEngagementCostCentersFlag | Boolean | No | false | If set to 'true', all cost centers including those that are not enabled for resources or engagements will be returned. This flag is disregarded if a cost center is specified. | true |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetCostCenterList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>ARKG+qjBuMq+YMu7gEYnoA==</req:SessionTicket>
<req:CostCenterIdentity>
<com:CostCenterName>SCT Associates (USA)</com:CostCenterName>
</req:CostCenterIdentity>
<req:IncludeAncestorsFlag>false</req:IncludeAncestorsFlag>
<req:IncludeEngagementCostCentersFlag>true</req:IncludeEngagementCostCentersFlag>
<req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
<req:IncludeResourceCostCentersFlag>true</req:IncludeResourceCostCentersFlag>
<req:IncludeNonResourceNonEngagementCostCentersFlag>true</req:IncludeNonResourceNonEngagementCostCentersFlag>
</pws:serviceRequest>
</pws:PwsGetCostCenterList>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-01-23T20:00:11.4720411Z | |
CostCenters | PwsCostCenterSummary[0..infinity] | The cost center summary records that were fetched by the service. Click for more information. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetCostCenterListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetCostCenterListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-23T19:58:29.2196953Z</ServerTimestampUtc>
<a:CostCenters xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsCostCenterSummary>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>USA</b:CostCenterName>
<b:CostCenterNumber>USA</b:CostCenterNumber>
<b:CostCenterUid>1152921504606867361</b:CostCenterUid>
<b:CompanyIdentity>
<b:CompanyId i:nil="true"/>
<b:CompanyName>USA</b:CompanyName>
<b:CompanyUid>1152921504606850739</b:CompanyUid>
<b:CompanyNumber>USA</b:CompanyNumber>
</b:CompanyIdentity>
<b:EnabledForEngagementsFlag>true</b:EnabledForEngagementsFlag>
<b:EnabledForResourcesFlag>false</b:EnabledForResourcesFlag>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentCostCenterIdentity i:nil="true"/>
</b:PwsCostCenterSummary>
<b:PwsCostCenterSummary>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Contractor (USA)</b:CostCenterName>
<b:CostCenterNumber>Contractor (USA)</b:CostCenterNumber>
<b:CostCenterUid>1152921504606873749</b:CostCenterUid>
<b:CompanyIdentity>
<b:CompanyId i:nil="true"/>
<b:CompanyName>USA</b:CompanyName>
<b:CompanyUid>1152921504606850739</b:CompanyUid>
<b:CompanyNumber>USA</b:CompanyNumber>
</b:CompanyIdentity>
<b:EnabledForEngagementsFlag>false</b:EnabledForEngagementsFlag>
<b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentCostCenterIdentity>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>USA</b:CostCenterName>
<b:CostCenterNumber>USA</b:CostCenterNumber>
<b:CostCenterUid>1152921504606867361</b:CostCenterUid>
</b:ParentCostCenterIdentity>
</b:PwsCostCenterSummary>
<b:PwsCostCenterSummary>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>SCT Associates (USA)</b:CostCenterName>
<b:CostCenterNumber>SCTA-21191</b:CostCenterNumber>
<b:CostCenterUid>1152921504606876001</b:CostCenterUid>
<b:CompanyIdentity>
<b:CompanyId i:nil="true"/>
<b:CompanyName>USA</b:CompanyName>
<b:CompanyUid>1152921504606850739</b:CompanyUid>
<b:CompanyNumber>USA</b:CompanyNumber>
</b:CompanyIdentity>
<b:EnabledForEngagementsFlag>false</b:EnabledForEngagementsFlag>
<b:EnabledForResourcesFlag>false</b:EnabledForResourcesFlag>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentCostCenterIdentity>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Contractor (USA)</b:CostCenterName>
<b:CostCenterNumber>Contractor (USA)</b:CostCenterNumber>
<b:CostCenterUid>1152921504606873749</b:CostCenterUid>
</b:ParentCostCenterIdentity>
</b:PwsCostCenterSummary>
</a:CostCenters>
</PwsGetCostCenterListResult>
</PwsGetCostCenterListResponse>
</s:Body>
</s:Envelope> |
PwsGetCostCenterList - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | Description |
|---|---|---|
57525 | CostCenterNotFound | The specified cost center does not exist. |