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

« Previous Version 3 Next »

Overview

For Reporting Only time cards, also known as FRO, are typically used by organizations when cutting over from their old time tracking system to Projector. Some organizations may also load FRO time cards when they enter time in another system, but want to use Projector as the system of record for measures like utilization. To learn more about FRO time cards Click Here.

This web service retrieves For Reporting Only (FRO) time cards, based upon a set of optional criteria:

  • A specified contract line item (PwsContractLineItemRef). FRO time cards will be under the specified contract line item. 
  • A specified Engagement (PwsEngagementRef). FRO time cards will be under the specified engagement. 
  • A specified external grouping identifier. FRO time cards will have the specified grouping identifier.
  • A specified location (PwsLocationRef). FRO time cards will have the specified location.
  • A specified project (PwsProjectRef). FRO time cards will be under the specified location.
  • A specified project rate type (PwsProjectRateTypeRef). FRO time cards will have the specified project rate type.
  • A specified project role (PwsProjectRoleRef). FRO time cards will be associated with the specified project role.
  • A specified project task (PwsProjectTaskRef). FRO time cards will be associated with the specified project task.
  • A specified project task type (PwsProjectTaskTypeRef). FRO time cards will be associated with the specified project task type.
  • A specified resource (PwsResourceRef). FRO Time cards and time off cards will be associated with the specified resource.
  • A specified time card (PwsTimeCardRef). This is an identity of an FRO time card. If specified, the results will be limited to the specified FRO time card. Note that the specified FRO time card must also satisfy any other applicable criteria.
  • A specified work date range. Only FRO time cards that satisfy any specified criteria within this date range will be returned.

Request Format


PwsGetFroTimeCards Request

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.

AYInKjj1Mym8XoGH6OiEqg==

BilledTimestampRangeEnd

DateTime

No


Only FRO time cards that have a billing date (in midnight UTC) before this date will be retrieved. The BilledTimestampRangeStart and BilledTimestampRangeEnd together determine which FRO time cards will be retrieved.

2023-12-31T00:00:00.000Z

BilledTimestampRangeStart

DateTime

No


Only FRO time cards that have a billing date (in midnight UTC) after this date will be retrieved. The BilledTimestampRangeStart and BilledTimestampRangeEnd together determine which FRO time cards will be retrieved.

2023-01-01T00:00:00.000Z

ContractLineItemIdentities

PwsContractLineItemRef

No


Only FRO time cards that are associated with these Contract Line Items will be retrieved.


EngagementIdentities

PwsEngagementRef

No


Only FRO time cards that are associated with these Engagements will be retrieved.


ExternalGroupingIdentifiers

Int32[]

No


This unique identifier allows users to group multiple FRO time cards together, most commonly user for reporting purposes. Only FRO time cards with these external grouping identifiers will be retrieved.

1212023

LocationIdentities

PwsLocationRef

No


Only FRO time cards with these Locations will be retrieved.


MaximumResults

Int32

Yes


The maximum number of FRO time cards to be retrieved.

100

ProjectIdentities

PwsProjectRef

No


Only FRO time cards that are associated with these Projects will be retrieved.


ProjectRateTypeIdentities

PwsProjectRateTypeRef

No


Only FRO time cards that are associated with these Project Rate Types will be retrieved.


ProjectRoleIdentities

PwsProjectRoleRef

No


Only FRO time cards that are associated with these Project Roles will be retrieved.


ProjectTaskIdentities

PwsProjectTaskRef

No


Only FRO time cards that are associated with these Tasks will be retrieved.


ProjectTaskTypeIdentities

PwsProjectTaskTypeRef

No


Only FRO time cards that are associated with these Task Types will be retrieved.


ResourceIdentities

PwsResourceRef

No


Only FRO time cards that are associated with these Resources will be retrieved.


TimeCardIdentities

PwsTimeCardRef

No


Only the specified FRO time cards will be retreived.


TimecardUidsAfter

Int64

No


A UID is a unique and immutable identifier for a time card. Only UIDs that are greater than the specified UID will be retrieved.

1

WorkDateRangeEnd

DateTime

No


Only FRO time cards that have a work date (in midnight UTC) before this date will be retrieved. The WorkDateRangeStart and WorkDateRangeStart together determine which FRO time cards will be retrieved.

2023-12-31T00:00:00.000Z

WorkDateRangeStart

DateTime

No


Only FRO time cards that have a work date (in midnight UTC) after this date will be retrieved. The WorkDateRangeStart and WorkDateRangeStart together determine which FRO time cards will be retrieved.

2023-01-01T00:00:00.000Z

Request Usage Example(s)


PwsGetFroTimeCardsRq 
<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/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetFroTimeCards>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AYInKjj1Mym8XoGH6OiEqg==</req:SessionTicket>
            <tim:BilledTimestampRangeEnd>2023-12-31T00:00:00.000Z</tim:BilledTimestampRangeEnd>
            <tim:BilledTimestampRangeStart>2023-01-01T00:00:00.000Z</tim:BilledTimestampRangeStart>
            <tim:ContractLineItemIdentities>
               <com:PwsContractLineItemRef>
                  <com:ContractLineItemCode>E001046-CL1</com:ContractLineItemCode>
               </com:PwsContractLineItemRef>
            </tim:ContractLineItemIdentities>
            <tim:EngagementIdentities>
               <com:PwsEngagementRef>
                  <com:EngagementCode>E001046</com:EngagementCode>
               </com:PwsEngagementRef>
            </tim:EngagementIdentities>
            <tim:ExternalGroupingIdentifiers>
               <arr:int>1212023</arr:int>
            </tim:ExternalGroupingIdentifiers>
            <tim:LocationIdentities>
               <com:PwsLocationRef>
                  <com:LocationName>USA - Illinois</com:LocationName>
               </com:PwsLocationRef>
            </tim:LocationIdentities>
            <tim:MaximumResults>100</tim:MaximumResults>
            <tim:ProjectIdentities>
               <com:PwsProjectRef>
                  <com:ProjectCode>E001046-P001</com:ProjectCode>
               </com:PwsProjectRef>
            </tim:ProjectIdentities>
            <tim:ProjectRateTypeIdentities>
               <com:PwsProjectRateTypeRef>
                  <com:ProjectRateTypeUid>1152921504607818384</com:ProjectRateTypeUid>
               </com:PwsProjectRateTypeRef>
            </tim:ProjectRateTypeIdentities>
            <tim:ProjectRoleIdentities>
               <com:PwsProjectRoleRef>
                  <com:ProjectRoleUid>1152921504611115473</com:ProjectRoleUid>
               </com:PwsProjectRoleRef>
            </tim:ProjectRoleIdentities>
            <tim:ProjectTaskIdentities>
               <com:PwsProjectTaskRef>
                  <com:ProjectTaskUid>1152921504610341347</com:ProjectTaskUid>
               </com:PwsProjectTaskRef>
            </tim:ProjectTaskIdentities>
            <tim:ProjectTaskTypeIdentities>
               <com:PwsProjectTaskTypeRef>
                  <com:ProjectTaskTypeUid>1152921504609305356</com:ProjectTaskTypeUid>
               </com:PwsProjectTaskTypeRef>
            </tim:ProjectTaskTypeIdentities>
            <tim:ResourceIdentities>
               <com:PwsResourceRef>
                  <com:ResourceDisplayName>Matt</com:ResourceDisplayName>
               </com:PwsResourceRef>
            </tim:ResourceIdentities>
            <tim:TimecardUidsAfter>1</tim:TimecardUidsAfter>
            <tim:WorkDateRangeEnd>2023-12-31T00:00:00.000Z</tim:WorkDateRangeEnd>
            <tim:WorkDateRangeStart>2023-01-01T00:00:00.000Z</tim:WorkDateRangeStart>
         </pws:serviceRequest>
      </pws:PwsGetFroTimeCards>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


PwsGetFroTimeCards Response

Response Elements


Element

Data Type

Description


Messages

PwsMessage

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


ResponseId

Int32

Click here for more information.

1
StatusRequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.


NextPageTimecardUidsAfter

Int64

If all of the FRO time cards that could have been retrieved were not returned, this field will be populated with the UID of the first FRO Time Card that was not retrieved with the current batch.

PwsFroTimeCards

/wiki/spaces/AD/pages/379977729[]

The details of the retrieved FRO Time Card(s).


Response Usage Example(s)


PwsGetFroTimeCardsRs 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetFroTimeCardsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetFroTimeCardsResult 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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the Development [appdevrc.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2023-12-01T22:01:20.448959Z</ServerTimestampUtc>
            <a:NextPageTimecardUidsAfter i:nil="true"/>
            <a:PwsFroTimeCards>
               <a:PwsFroTimecardElement>
                  <a:ApprovedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bettina</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>QA - BB</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Bettina</b:FirstName>
                     <b:LastName>Borces</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:ApprovedByUser>
                  <a:ApprovedTimestamp>2023-12-01T22:00:58.987Z</a:ApprovedTimestamp>
                  <a:BilledTimestamp>2023-12-01T22:00:58.987Z</a:BilledTimestamp>
                  <a:BillingAdjustmentAmount>0</a:BillingAdjustmentAmount>
                  <a:ContractLineItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ContractLineItemCode>E001046-CL1</b:ContractLineItemCode>
                     <b:ContractLineItemId i:nil="true"/>
                     <b:ContractLineItemUid>1152921504607303649</b:ContractLineItemUid>
                  </a:ContractLineItemIdentity>
                  <a:ContractLineItemName>Engagement: For Reporting Only (A)</a:ContractLineItemName>
                  <a:CreatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bettina</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>QA - BB</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Bettina</b:FirstName>
                     <b:LastName>Borces</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:CreatedByUser>
                  <a:CreatedTimestamp>2023-12-01T22:00:58.987Z</a:CreatedTimestamp>
                  <a:DayFraction>0</a:DayFraction>
                  <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CurrencyCode>USD</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                  </a:EngagementCurrencyIdentity>
                  <a:EngagementIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementCode>E001046</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607761114</b:EngagementUid>
                  </a:EngagementIdentity>
                  <a:EngagementName>Engagement: For Reporting Only (A)</a:EngagementName>
                  <a:FroTimecardDetail>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType>
                     <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504749719168</TimecardUid>
                     <a:AdjustedRevenueAmount>100</a:AdjustedRevenueAmount>
                     <a:ContractRevenueAmount>100</a:ContractRevenueAmount>
                     <a:Description>PwsSaveFroTimeCards</a:Description>
                     <a:DescriptionClearFlag i:nil="true"/>
                     <a:ExternalGroupingIdentifier>1212023</a:ExternalGroupingIdentifier>
                     <a:ExternalGroupingIdentifierClearFlag i:nil="true"/>
                     <a:LocationClearFlag i:nil="true"/>
                     <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:LocationId i:nil="true"/>
                        <b:LocationName>USA - Illinois</b:LocationName>
                        <b:LocationUid>1152921504606863508</b:LocationUid>
                     </a:LocationIdentity>
                     <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectCode>E001046-P001</b:ProjectCode>
                        <b:ProjectId i:nil="true"/>
                        <b:ProjectUid>1152921504607686008</b:ProjectUid>
                     </a:ProjectIdentity>
                     <a:ProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ExternalSystemIdentifier i:nil="true"/>
                        <b:ProjectRateTypeId i:nil="true"/>
                        <b:ProjectRateTypeUid>1152921504607818384</b:ProjectRateTypeUid>
                     </a:ProjectRateTypeIdentity>
                     <a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ExternalSystemIdentifier i:nil="true"/>
                        <b:ProjectRoleId i:nil="true"/>
                        <b:ProjectRoleUid>1152921504611115473</b:ProjectRoleUid>
                     </a:ProjectRoleIdentity>
                     <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ExternalSystemIdentifier i:nil="true"/>
                        <b:ProjectTaskId i:nil="true"/>
                        <b:ProjectTaskUid>1152921504610341347</b:ProjectTaskUid>
                     </a:ProjectTaskIdentity>
                     <a:ResourceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ResourceDisplayName>Matt</b:ResourceDisplayName>
                        <b:ResourceId i:nil="true"/>
                        <b:ResourceReferenceSystemId>Dev Manager - MJ</b:ResourceReferenceSystemId>
                        <b:ResourceUid>1152921504607057128</b:ResourceUid>
                     </a:ResourceIdentity>
                     <a:SystemRevenueAmount>100</a:SystemRevenueAmount>
                     <a:Timestamp>AAAAADKCBmU=</a:Timestamp>
                     <a:Udf1ClearFlag i:nil="true"/>
                     <a:Udf1Value xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UdfId i:nil="true"/>
                        <b:UdfName>TC-Text List</b:UdfName>
                        <b:UdfUid>1152921504606864090</b:UdfUid>
                        <b:BooleanValue i:nil="true"/>
                        <b:DataType>L</b:DataType>
                        <b:DateValue i:nil="true"/>
                        <b:IntegerValue i:nil="true"/>
                        <b:ResourceIdentityValue i:nil="true"/>
                        <b:TextValue i:nil="true"/>
                        <b:UdfTreatment>A</b:UdfTreatment>
                        <b:StoplightValues/>
                        <b:NumericValue i:nil="true"/>
                        <b:RelationValue i:nil="true"/>
                        <b:StoplightValuesClearFlag>false</b:StoplightValuesClearFlag>
                     </a:Udf1Value>
                     <a:Udf2ClearFlag i:nil="true"/>
                     <a:Udf2Value xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UdfId i:nil="true"/>
                        <b:UdfName>TC-Numeric</b:UdfName>
                        <b:UdfUid>1152921504606864086</b:UdfUid>
                        <b:BooleanValue i:nil="true"/>
                        <b:DataType>I</b:DataType>
                        <b:DateValue i:nil="true"/>
                        <b:IntegerValue i:nil="true"/>
                        <b:ResourceIdentityValue i:nil="true"/>
                        <b:TextValue i:nil="true"/>
                        <b:UdfTreatment>A</b:UdfTreatment>
                        <b:StoplightValues/>
                        <b:NumericValue i:nil="true"/>
                        <b:RelationValue i:nil="true"/>
                        <b:StoplightValuesClearFlag>false</b:StoplightValuesClearFlag>
                     </a:Udf2Value>
                     <a:WorkDate>2023-11-06T00:00:00Z</a:WorkDate>
                     <a:WorkMinutes>45</a:WorkMinutes>
                  </a:FroTimecardDetail>
                  <a:LastUpdatedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bettina</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>QA - BB</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Bettina</b:FirstName>
                     <b:LastName>Borces</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:LastUpdatedByUser>
                  <a:LastUpdatedTimestamp>2023-12-01T22:00:58.987Z</a:LastUpdatedTimestamp>
                  <a:ProjectName>Engagement: For Reporting Only (A)</a:ProjectName>
                  <a:ProjectTaskFullWbsCode>1</a:ProjectTaskFullWbsCode>
                  <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskTypeId i:nil="true"/>
                     <b:ProjectTaskTypeUid>1152921504609305356</b:ProjectTaskTypeUid>
                  </a:ProjectTaskTypeIdentity>
                  <a:RevRecAdjustmentAmount>0</a:RevRecAdjustmentAmount>
               </a:PwsFroTimecardElement>
            </a:PwsFroTimeCards>
         </PwsGetFroTimeCardsResult>
      </PwsGetFroTimeCardsResponse>
   </s:Body>
</s:Envelope>


PwsGetFroTimeCards - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

10119ValueBelowMinimumThe value specified in the field "MaximumResults" in the class "PwsGetFroTimeCardsRq" is out of range. The value must not be less than 1.
50024EntityNotFoundContract Line Item was not found. Another user may have deleted it. / Engagement was not found. Another user may have deleted it. / Location was not found. Another user may have deleted it. / Project was not found. Another user may have deleted it.
64249SpecifiedDateRangeMissingIncompleteOrInvalidA specified date range was missing, incomplete or invalid. Both the start and end dates must be specified, and the start date may not be after the end date.
  • No labels