Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This web service retrieves a list of cost cener summary records (PwsCostCenterRef), based on specified search criteria (PwsCostCenterRef). 

Request Format


PwsGetCostCenterList Request
  • PwsGetCostCenterList
    • serviceRequest: PwsGetCostCenterListRq
      • RequestId: Int32
      • SessionTicket: String
      • CostCenterIdentity: PwsCostCenterRef
      • IncludeAncestorsFlag: Boolean
      • IncludeEngagementCostCentersFlag: Boolean
      • IncludeInactiveFlag: Boolean
      • IncludeResourceCostCentersFlag: Boolean
      • QueryString: String
      • IncludeNonResourceNonEngagementCostCentersFlag: Boolean

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 No

 

Click here for more information.

 

SessionTicket

String

Yes 

 

Click here for more information.

 

CostCenterIdentity

PwsCostCenterRef

No 

 

For this service, the caller may specify up to 1 cost center identity. If a cost center identity is not specified all clients fitting the criteria will be returned. Click here for more information.

 

IncludeAncestorsFlag

Boolean

No

false

If set to 'true', the ancestors (i.e. parent, grandparent) 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.

 

IncludeEngagementCostCentersFlag

Boolean

No 

false 

If set to 'true', only cost centers enabled for engagements will be returned. This flag is disregarded if a cost center is specified.

 

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.

 

IncludeResourceCostCentersFlag

Boolean

No 

false 

If set to 'true', only cost centers enabled for resources will be returned. This flag is disregarded if a cost center is specified.

 

QueryString

String

No 

 

The cost centers that are returned will contain the value in this field. This flag is disregarded if a cost center is specified.

 

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.

 

Request Usage Example(s)


Example 01 - Cost Center is specified 
<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>

Response Usage Example(s)


Example 01 - without ancestors 
<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-23T20:00:11.4720411Z</ServerTimestampUtc>
            <a:CostCenters xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <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>
Example 02 - with ancestors 
<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>
  • No labels