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 service will raise an error if any of the time cards specified explicitly in TimeCardIdentities do not exist, are not FRO time cards, or could not be viewed for any reason.
| Info | ||
|---|---|---|
| ||
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 | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AYInKjj1Mym8XoGH6OiEqg== | ||
BilledTimestampRangeEnd | DateTime | No | Only FRO time cards that have a billing timestamp (in UTC) on or before this date will be retrieved. If one or both is specified, 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 timestamp (in UTC) on or after this date will be retrieved. If one or both is specified, the BilledTimestampRangeStart and BilledTimestampRangeEnd together determine which FRO time cards will be retrieved. | 2023-01-01T00:00:00.000Z | |
ContractLineItemIdentities | No | Only FRO time cards that are associated with these Contract Line Items will be retrieved. | |||
EngagementIdentities | 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 | No | Only FRO time cards with these Locations will be retrieved. | |||
MaximumResults | Int32 | Yes | The maximum number of FRO time cards to be retrieved. Maximum value is 100,000. If not specified, the 100,000 limit will be enforced. | 100 | |
ProjectIdentities | No | Only FRO time cards that are associated with these Projects will be retrieved. | |||
ProjectRateTypeIdentities | No | Only FRO time cards that are associated with these Project Rate Types will be retrieved. | |||
ProjectRoleIdentities | No | Only FRO time cards that are associated with these Project Roles will be retrieved. | |||
ProjectTaskIdentities | No | Only FRO time cards that are associated with these Tasks will be retrieved. | |||
ProjectTaskTypeIdentities | No | Only FRO time cards that are associated with these Task Types will be retrieved. | |||
ResourceIdentities | No | Only FRO time cards that are associated with these Resources will be retrieved. | |||
TimeCardIdentities | No | Only the specified FRO time card(s) will be retrieved. | |||
TimecardUidsAfter | Int64 | No | Only UIDs that are greater than the specified UID will be retrieved. Used in conjunction with MaximumResults and NextPageTimecardUidsAfter (response) to page through results as described above. | 1 | |
WorkDateRangeEnd | DateTime | No | Only FRO time cards that have a work date (in midnight UTC) before this date will be retrieved. If one or both is specified, 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. If one or both is specified, the WorkDateRangeStart and WorkDateRangeStart together determine which FRO time cards will be retrieved. | 2023-01-01T00:00:00.000Z |
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: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> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
| Status | RequestStatus | Click here for more information. | |
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 | The details of the retrieved FRO Time Card(s). |
Response Usage Example(s)
...