Versions Compared

Version Old Version 1 New Version 2
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Panel
titlePwsGetCostCenterList 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)


Code Block
languagexml
titleExample 01 - Cost Center is specified
collapsetrue
<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>
Code Block
languagexml
titleExample 02 - Cost Center is not specified
collapsetrue
<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:IncludeAncestorsFlag>false</req:IncludeAncestorsFlag>
            <req:IncludeEngagementCostCentersFlag>true</req:IncludeEngagementCostCentersFlag>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:IncludeResourceCostCentersFlag>false</req:IncludeResourceCostCentersFlag>
            <req:QueryString>test</req:QueryString>
            <req:IncludeNonResourceNonEngagementCostCentersFlag>false</req:IncludeNonResourceNonEngagementCostCentersFlag>
         </pws:serviceRequest>
      </pws:PwsGetCostCenterList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsGetCostCenterList Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage

 The web service response status and message. Click here for more information.

 

ResponseId

Int32

Click here for more information.

1

Status

RequestStatus

Click here for more information.

Ok 

ServerTimestampUtc

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)

...