Versions Compared

Version Old Version 1 New Version Current
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

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

Overview


This web services returns invoices based on the criteria specifiedtransactional data about reported time. The service will return time reporting activity since a specified bookmark. A new bookmark is returned in the response. When invoking this service as a later time, the new bookmark can be passed to it to retrieve all activity since the last time the service was invoked.


Info
titleRate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


Panel
titlePwsExportIncrementalTimeFeed Request
  • PwsExportIncrementalTimeFeed
    • serviceRequest: PwsExportIncrementalTimeFeedRq
      • RequestId: Int32
      • SessionTicket: String
      • Bookmark64: String
      • CostCenterIdentity: PwsCostCenterRef
      • IncludeBillableTimeFlag: Boolean
      • IncludeMode: String
      • IncludeNonbillableTimeFlag: Boolean
      • IncludeTempWorkersFlag: Boolean
      • IncludeTimeOffFlag: Boolean
      • MaxRowsToReturn: Int32
      • ResourceFilteringFlag: Boolean

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

1

SessionTicket

String

Yes 

 


Click here for more information.

AdASLLZalvehjm71D72agw==

Bookmark64

String

No 

 


Bookmark (represents the last data previously exported by this web service a new bookmark value will be returned each time the service is executed)

AACjOQDZyD1UEAAAAAHhbLkAAAAAAAAAAg==

CostCenterIdentity

PwsCostCenterRef

One of CostCenterIdentity, IncludeBillableTimeFlag, IncludeNonbillableTimeFlag, IncludeTempWorkersFlag, IncludeTimeOffFlag or ResourceFilteringFlag is required

 

No


The cost center to filter by

 


IncludeBillableTimeFlag

Boolean

No 

false

If set to 'true', include billable time cards only

true

IncludeMode

String

Yes

 


The include mode:

'S' for submissions

'A' for approvals

'B' for both submissions and approvals

B

IncludeNonbillableTimeFlag

Boolean

See CostCenterIdentity

No

false

If set to 'true', include non-billable time cards

true

IncludeTempWorkersFlag

Boolean

See CostCenterIdentity

No

true

If set to 'true', include time cards associated with temporary workers

true 

IncludeTimeOffFlag

Boolean

See CostCenterIdentity

No

false 

If set to 'true', include time off cards

true

MaxRowsToReturn

Int32

No

 


The maximum number of data rows to return 

1

ResourceFilteringFlag

Boolean

See CostCenterIdentity

No

false

If 0, filter based upon engagement cost center, if 1 filter based upon resource cost center

false

Request Usage Example(s)


Code Block
languagexml
titleExample 01
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:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsExportIncrementalTimeFeed>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdASLLZalvehjm71D72agw==</req:SessionTicket>
            <tim:Bookmark64>AACjOQDZyD1UEAAAAAHhbLkAAAAAAAAAAg==</tim:Bookmark64>
            <tim:CostCenterIdentity>:IncludeBillableTimeFlag>true</tim:IncludeBillableTimeFlag>
            <tim:IncludeMode>B</tim:IncludeMode>
         <com:CostCenterNumber>USA</com:CostCenterNumber>   <tim:IncludeNonbillableTimeFlag>true</tim:IncludeNonbillableTimeFlag>
            <<tim:IncludeTempWorkersFlag>true</tim:CostCenterIdentity>IncludeTempWorkersFlag>
            <tim:IncludeBillableTimeFlag>true<IncludeTimeOffFlag>true</tim:IncludeBillableTimeFlag>IncludeTimeOffFlag>
            <tim:IncludeMode>B<MaxRowsToReturn>1</tim:IncludeMode>MaxRowsToReturn>
            <tim:IncludeNonbillableTimeFlag>true</tim:IncludeNonbillableTimeFlag>ResourceFilteringFlag>false</tim:ResourceFilteringFlag>
         </pws:serviceRequest>
      </pws:PwsExportIncrementalTimeFeed>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsExportIncrementalTimeFeed 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-03-14T18:21:43.3061187Z

Bookmark64

String

Bookmark representing the last data returned by this invocation. Consumers will typically save this value and use it at a later time to retrieve additional activity.

AACjOQDZyD1UEAAAAAHhbLoAAAAAAAAAAg==

Feed

PwsTimeFeedRecord[]

The details of the time card


RowCount

Int32

The total number of rows returned by the service

1

Response Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsExportIncrementalTimeFeedResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsExportIncrementalTimeFeedResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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-03-14T18:21:43.3061187Z</ServerTimestampUtc>
            <a:Bookmark64>AACjOQDZyD1UEAAAAAHhbLoAAAAAAAAAAg==</a:Bookmark64>
            <a:Feed xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimeFeedRecord>
                  <b:EngagementCompanyIdentity>
                     <b:CompanyId i:nil="true"/>
                     <b:CompanyName>USA</b:CompanyName>
                     <b:CompanyUid>1152921504606850739</b:CompanyUid>
                     <b:CompanyNumber>USA</b:CompanyNumber>
                  </b:EngagementCompanyIdentity>
                  <b:EngagementCostCenterIdentity>
                     <b:CostCenterId i:nil="true"/>
                     <b:CostCenterName>USA</b:CostCenterName>
                     <b:CostCenterNumber>USA</b:CostCenterNumber>
                     <b:CostCenterUid>1152921504606867361</b:CostCenterUid>
                  </b:EngagementCostCenterIdentity>
                  <b:EngagementTypeBillableFlag>true</b:EngagementTypeBillableFlag>
                  <b:EngagementTypeIdentity>
                     <b:EngagementTypeId i:nil="true"/>
                     <b:EngagementTypeName>Billable - Not to Exceed</b:EngagementTypeName>
                     <b:EngagementTypeShortName>NTE</b:EngagementTypeShortName>
                     <b:EngagementTypeUid>1152921504606863891</b:EngagementTypeUid>
                  </b:EngagementTypeIdentity>
                  <b:ProjectIdentity>
                     <b:ProjectCode>COST MANAGEMENT</b:ProjectCode>
                     <b:ProjectId i:nil="true"/>
                     <b:ProjectUid>1152921504607283516</b:ProjectUid>
                  </b:ProjectIdentity>
                  <b:ProjectRateType>
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectRateTypeId i:nil="true"/>
                     <b:ProjectRateTypeUid>1152921504607119402</b:ProjectRateTypeUid>
                     <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName>
                  </b:ProjectRateType>
                  <b:ProjectTaskIdentity>
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskId i:nil="true"/>
                     <b:ProjectTaskUid>1152921504608048883</b:ProjectTaskUid>
                  </b:ProjectTaskIdentity>
                  <b:ProjectTaskType>
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskTypeId i:nil="true"/>
                     <b:ProjectTaskTypeUid>1152921504607683476</b:ProjectTaskTypeUid>
                     <b:ProjectTaskTypeName>Design</b:ProjectTaskTypeName>
                  </b:ProjectTaskType>
                  <b:ResourceCompanyIdentity>
                     <b:CompanyId i:nil="true"/>
                     <b:CompanyName>USA</b:CompanyName>
                     <b:CompanyUid>1152921504606850739</b:CompanyUid>
                     <b:CompanyNumber>USA</b:CompanyNumber>
                  </b:ResourceCompanyIdentity>
                  <b:ResourceCostCenterIdentity>
                     <b:CostCenterId i:nil="true"/>
                     <b:CostCenterName>IT Team (USA)</b:CostCenterName>
                     <b:CostCenterNumber>IT Team (USA)</b:CostCenterNumber>
                     <b:CostCenterUid>1152921504606867365</b:CostCenterUid>
                  </b:ResourceCostCenterIdentity>
                  <b:ResourceIdentity>
                     <b:ResourceDisplayName>Chris McFarlane</b:ResourceDisplayName>
                     <b:ResourceId i:nil="true"/>
                     <b:ResourceReferenceSystemId>IT (USA) - 10</b:ResourceReferenceSystemId>
                     <b:ResourceUid>1152921504607059016</b:ResourceUid>
                  </b:ResourceIdentity>
                  <b:ResourceLocationIdentity>
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>USA</b:LocationName>
                     <b:LocationUid>1152921504606855985</b:LocationUid>
                  </b:ResourceLocationIdentity>
                  <b:StandardRateTypeIdentity>
                     <b:StandardRateTypeCode>Reg</b:StandardRateTypeCode>
                     <b:StandardRateTypeId i:nil="true"/>
                     <b:StandardRateTypeName>Regular</b:StandardRateTypeName>
                     <b:StandardRateTypeUid>1152921504606847729</b:StandardRateTypeUid>
                  </b:StandardRateTypeIdentity>
                  <b:StandardTaskTypeIdentity>
                     <b:StandardTaskTypeCode>TT05</b:StandardTaskTypeCode>
                     <b:StandardTaskTypeId i:nil="true"/>
                     <b:StandardTaskTypeName>Task Type 05</b:StandardTaskTypeName>
                     <b:StandardTaskTypeUid>1152921504606848776</b:StandardTaskTypeUid>
                  </b:StandardTaskTypeIdentity>
                  <b:TimeCardIdentity>
                     <b:ReferenceId i:nil="true"/>
                     <b:TimecardId i:nil="true"/>
                     <b:TimecardType>T</b:TimecardType>
                     <b:TimecardUid>1152921504638397626</b:TimecardUid>
                  </b:TimeCardIdentity>
                  <b:TimeOffReasonIdentity i:nil="true"/>
                  <b:TimecardLocationIdentity i:nil="true"/>
                  <b:TimecardStatus>S</b:TimecardStatus>
                  <b:WorkOrTimeOffDate>2014-05-29T00:00:00Z</b:WorkOrTimeOffDate>
                  <b:WorkOrTimeOffMinutes>480</b:WorkOrTimeOffMinutes>
                  <b:Udf1>
                     <b:BooleanValue i:nil="true"/>
                     <b:DateValue i:nil="true"/>
                     <b:IntegerValue i:nil="true"/>
                     <b:TextValue i:nil="true"/>
                     <b:RelationValue i:nil="true"/>
                     <b:NumericValue i:nil="true"/>
                  </b:Udf1>
                  <b:Udf2>
                     <b:BooleanValue i:nil="true"/>
                     <b:DateValue i:nil="true"/>
                     <b:IntegerValue i:nil="true"/>
                     <b:TextValue i:nil="true"/>
                     <b:RelationValue i:nil="true"/>
                     <b:NumericValue i:nil="true"/>
                  </b:Udf2>
                  <b:EngagementIdentity>
                     <b:EngagementCode>P001018</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <tim:IncludeTempWorkersFlag>true</tim:IncludeTempWorkersFlag><b:EngagementUid>1152921504607199009</b:EngagementUid>
                  </b:EngagementIdentity>
                  <b:ProjectRoleIdentity>
                     <tim:IncludeTimeOffFlag>true</tim:IncludeTimeOffFlag><b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectRoleId i:nil="true"/>
                     <tim:MaxRowsToReturn>1</tim:MaxRowsToReturn><b:ProjectRoleUid>1152921504608875516</b:ProjectRoleUid>
                  </b:ProjectRoleIdentity>
                  <tim<b:ResourceFilteringFlag>false</tim:ResourceFilteringFlag>ProjectRoleName>Chris</b:ProjectRoleName>
                  <b:ExternalGroupingIdentifier i:nil="true"/>
               </pws:serviceRequest>b:PwsTimeFeedRecord>
            </pws:PwsExportIncrementalTimeFeed>a:Feed>
            <a:RowCount>1</a:RowCount>
         </PwsExportIncrementalTimeFeedResult>
      </PwsExportIncrementalTimeFeedResponse>
   </soapenvs:Body>
</soapenv:Envelope>s:Envelope>

PwsExportIncrementalTimeFeed - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

18003InvalidBookmarkThe specified bookmark is not recognized as a valid bookmark. The bookmark, if specified, must have been returned by a prior call to this service or provided by Projector technical support.
64215InvalidValueForIncludeModeThe value specified for IncludeMode is invalid. Valid values are S for submissions, A for approvals or B for both submissions and approvals.