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
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 |
Yes
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 |
Boolean
No
false
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. |
false
IncludeBookedAndAssignedRolesFlag
Boolean
No
false
If set to 'true', projects on which the resource is booked for hours during the period or booked or requested on a role that is assigned to a task that is active during the period are included, regardless of whether time cards exist. Active tasks are tasks whose planned dates overlap with this period, or whose planned dates are prior to the period but is not marked complete.
true
IncludeDraftFlag
Boolean
No
false
If set to 'true', draft time cards will be included in the response.
true
IncludeReferencedTasksOnlyFlag
Boolean
No
false
If set to 'true', only tasks that are referred to by existing time cards will be included in the response.
true
IncludeReferencedTimeOffReasonsOnlyFlag
Boolean
No
false
If set to 'true', only time off reaons that are referred to by existing time off cards will be included in the response.
true
IncludeRejectedFlag
Boolean
No
false
If set to 'true', rejected time cards will be included in the response.
false
IncludeSubmittedFlag
Boolean
No
false
If set to 'true', submitted time cards will be included in the response.
true
IncludeTimeCardsFlag
Boolean
No
false
If set to 'true', time cards (as opposed to time off cards) will be included in the response.
true
IncludeTimeOffCardsFlag
Boolean
No
false
If set to 'true, time off cards will be included in the response.
false
ProjectIdentity
No
ResourceIdentity
Yes/No
The ResourceIdentity is not required, but practically speaking should always be specified.
The field is not required because we'll fall back to the user/resource that the web service request came from. However, if that user has no resource profile, you'll get a 50406 error.
StartDate
DateTime
Yes
The start date (in midnight UTC) of a time period. The StartDate and EndDate together define the period in which the time cards will be retrieved. The time cards that are to be retrieved must be dated on or after the StartDate and on or prior to the EndDate.
2018-01-01T00:00:00.000Z
IncludeTaskHierarchyFlag
Boolean
No
false
If set to 'true', all the entire task hierarchy of the task associated with the time card(s) will be included.
false
AutoMemorizeBookedAndAssignedRolesFlag
Boolean
No
false
If set to 'true', anything that was on the timesheet last week will be on it this week. If set to 'false', timesheet start from scratch each week. This is intended for internal use and you likely want to set this to false.
false
IncludeMemorizedRolesAndTasksFlag
Boolean
No
false
If set to 'true', memorized roles and tasks will be included in the response. Memorized roles and tasks are roles that may not have any time cards associated with them, but have been explicitly added to a resource's time sheet through the Projector UI.
false
RespectMemorizedRemovedRolesAndTasksFlag
Boolean
No
false
If set to 'true', roles and tasks that were removed from the timesheet will be excluded from the response. Again, this refers to rows on a resource's time sheet that may be connected to tasks that the resource is assigned to, but have been explicitly removed from the resource's timesheet through the Projector UI.
false
TimeCardIdentity
No
Identity of the time card, if requesting a single time card. This can refer to a time card or a time off card.
Request Usage Example(s)
...
language | xml |
---|---|
title | Example 01 |
collapse | true |
...
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. | 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 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)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/PwsProjectorServicesRequests/" xmlns:reqtim="http://projectorpsa.com/DataContracts/RequestsShared/TimeAndCost/" xmlns:timcom="http://projectorpsa.com/DataContracts/Shared/TimeAndCostCommon/" xmlns:comarr="http://projectorpsaschemas.microsoft.com/DataContracts2003/Shared10/CommonSerialization/Arrays"> <soapenv:Header/> <soapenv:Body> <pws:PwsGetTimeCards>PwsGetFroTimeCards> <pws:serviceRequest> <req:RequestId>1</req:RequestId> <req:SessionTicket>AdW9hL5iEq/mAQnDQ5AweASessionTicket>AYInKjj1Mym8XoGH6OiEqg==</req:SessionTicket> <tim:EndDate>2018BilledTimestampRangeEnd>2023-12-31T00:00:00.000Z</tim:EndDate>BilledTimestampRangeEnd> <tim:IncludeApprovedFlag>false<BilledTimestampRangeStart>2023-01-01T00:00:00.000Z</tim:IncludeApprovedFlag>BilledTimestampRangeStart> <tim:IncludeBookedAndAssignedRolesFlag>true</tim:IncludeBookedAndAssignedRolesFlag>ContractLineItemIdentities> <tim:IncludeDraftFlag>true</tim:IncludeDraftFlag> <com:PwsContractLineItemRef> <tim:IncludeReferencedTasksOnlyFlag>true</tim:IncludeReferencedTasksOnlyFlag> <com:ContractLineItemCode>E001046-CL1</com:ContractLineItemCode> <tim:IncludeReferencedTimeOffReasonsOnlyFlag>true</tim:IncludeReferencedTimeOffReasonsOnlyFlag> <tim:IncludeRejectedFlag>false</tim:IncludeRejectedFlag></com:PwsContractLineItemRef> <tim:IncludeSubmittedFlag>true<</tim:IncludeSubmittedFlag>ContractLineItemIdentities> <tim:IncludeTimeCardsFlag>true</tim:IncludeTimeCardsFlag> EngagementIdentities> <tim:IncludeTimeOffCardsFlag>false</tim:IncludeTimeOffCardsFlag> <com:PwsEngagementRef> <tim:ProjectIdentity> <com:ProjectCode>P001395-001<EngagementCode>E001046</com:ProjectCode>EngagementCode> </timcom:ProjectIdentity>PwsEngagementRef> <tim:StartDate>2018-01-01T00:00:00.000Z<</tim:StartDate>EngagementIdentities> <tim:IncludeTaskHierarchyFlag>false</tim:IncludeTaskHierarchyFlag>ExternalGroupingIdentifiers> <tim<arr:AutoMemorizeBookedAndAssignedRolesFlag>false<int>1212023</timarr:AutoMemorizeBookedAndAssignedRolesFlag>int> <tim:IncludeMemorizedRolesAndTasksFlag>false<</tim:IncludeMemorizedRolesAndTasksFlag>ExternalGroupingIdentifiers> <tim:RespectMemorizedRemovedRolesAndTasksFlag>false</tim:RespectMemorizedRemovedRolesAndTasksFlag>LocationIdentities> <com:PwsLocationRef> <com:LocationName>USA - <Illinois</pws:serviceRequest>com:LocationName> </pws:PwsGetTimeCards> </soapenv:Body> </soapenv:Envelope> |
Response Format
Panel | ||
---|---|---|
| ||
|
Response Elements
...
Element
...
Data Type
...
Description
...
Sample Data
...
Messages
...
...
The web service response status and message. Click here for more information.
...
ResponseId
...
Int32
...
Click here for more information.
...
1
...
Status
...
...
Click here for more information.
...
Ok
...
ServerTimestampUtc
...
DateTime
...
Click here for more information.
...
2018-03-06T20:16:49.6052125Z
...
Locations
...
...
The location(s) associated with the time card(s).
...
TimeEntryProjects
...
...
The project(s) associated with the time card(s). The actual time cards included in the response are grouped by project here.
...
TimeEntryTimeOff
...
...
The time off reason(s) associated with the time card(s). The actual time off cards included in the response are grouped by time off reason here.
Response Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body>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> <PwsGetTimeCardsResponse xmlns="http<com:ProjectRateTypeUid>1152921504607818384<//projectorpsa.com/PwsProjectorServices/">com:ProjectRateTypeUid> <PwsGetTimeCardsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> </com:PwsProjectRateTypeRef> </tim:ProjectRateTypeIdentities> <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <tim:ProjectRoleIdentities> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId> <com:PwsProjectRoleRef> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-06T20:16:49.6052125Z</ServerTimestampUtc><com:ProjectRoleUid>1152921504611115473</com:ProjectRoleUid> <a:Locations xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> </com:PwsProjectRoleRef> </tim:ProjectRoleIdentities> <b:PwsLocationSummary> <tim:ProjectTaskIdentities> <b:LocationId i:nil="true"/><com:PwsProjectTaskRef> <b<com:LocationName>USA<ProjectTaskUid>1152921504610341347</bcom:LocationName>ProjectTaskUid> </com:PwsProjectTaskRef> <b:LocationUid>1152921504606855985</b:LocationUid> </tim:ProjectTaskIdentities> <b:CurrencyIdentity> <tim:ProjectTaskTypeIdentities> <com:PwsProjectTaskTypeRef> <b:CurrencyCode>USD</b:CurrencyCode> <com:ProjectTaskTypeUid>1152921504609305356</com:ProjectTaskTypeUid> <b:CurrencyId i:nil="true"/> </com:PwsProjectTaskTypeRef> <b:CurrencyUid>1152921504606851838<</btim:CurrencyUid>ProjectTaskTypeIdentities> </b:CurrencyIdentity><tim:ResourceIdentities> <b:InactiveFlag>false</b:InactiveFlag><com:PwsResourceRef> <b<com:MileageUom>M<ResourceDisplayName>Matt</bcom:MileageUom>ResourceDisplayName> </com:PwsResourceRef> <b:OpsCurrencyIdentity> </tim:ResourceIdentities> <b<tim:OpsCurrencyCode>USD<TimecardUidsAfter>1</b:OpsCurrencyCode>tim:TimecardUidsAfter> <tim:WorkDateRangeEnd>2023-12-31T00:00:00.000Z</tim:WorkDateRangeEnd> <b:OpsCurrencyId i:nil="true"/> <tim:WorkDateRangeStart>2023-01-01T00:00:00.000Z</tim:WorkDateRangeStart> </bpws:OpsCurrencyIdentity>serviceRequest> <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag></pws:PwsGetFroTimeCards> <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag> <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag> <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag> </b:PwsLocationSummary> </a:Locations> <a:TimeEntryProjects> <a:PwsTimeEntryProject> <a:AllowAssignmentFlag>true</a:AllowAssignmentFlag> <a:AllowBookingFlag>true</a:AllowBookingFlag> <a:CanOpenFlag>false</a:CanOpenFlag> <a:CloseDate i:nil="true"/> <a:DescriptionRequiredFlag>false</a:DescriptionRequiredFlag> <a:OpenDate>2018-01-01T00:00:00Z</a:OpenDate> <a:OpenFlag>true</a:OpenFlag> <a:PmModuleEnabledFlag>true</a:PmModuleEnabledFlag> <a:ProjectDescriptor> <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001395-001</ProjectCode> <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607412209</ProjectUid> <a:EngagementDescriptor> <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001395</EngagementCode> <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607324698</EngagementUid> <a:ClientDescriptor> <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber> <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid> <a:ClientName>Projector PSA</a:ClientName> <a:ParentClientDescriptor i:nil="true"/> </a:ClientDescriptor> <a:EngagementManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:EngagementManager> <a:EngagementName>Web Services Engagement</a:EngagementName> <a:EngagementTypeDescriptor> <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time and Materials</EngagementTypeName> <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">TandM</EngagementTypeShortName> <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606863884</EngagementTypeUid> <a:BillableFlag>true</a:BillableFlag> </a:EngagementTypeDescriptor> <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits> <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:EngagementDescriptor> <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:LocationId i:nil="true"/> <b:LocationName>USA</b:LocationName> <b:LocationUid>1152921504606855985</b:LocationUid> </a:LocationIdentity> <a:ProjectCloseDate i:nil="true"/> <a:ProjectDescription i:nil="true"/> <a:ProjectManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Jack Spratt</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>E123</b:UserReferenceSystemId> <b:UserUid>1152921504607112369</b:UserUid> <b:EmailAddress>jack@revcorp.bb</b:EmailAddress> <b:FirstName>Jack</b:FirstName> <b:LastName>Spratt</b:LastName> <b:MiddleName i:nil="true"/> </a:ProjectManager> <a:ProjectName>New Web Services Project (A)</a:ProjectName> <a:ProjectOpenDate>2018-01-01T00:00:00Z</a:ProjectOpenDate> <a:ProjectRoles> <a:PwsRole> <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609522500</ProjectRoleUid> <a:RoleEndDate i:nil="true"/> <a:RoleName>JS</a:RoleName> <a:RoleStartDate>2018-01-01T00:00:00Z</a:RoleStartDate> </a:PwsRole> </a:ProjectRoles> <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ProjectStageId i:nil="true"/> <b:ProjectStageName>Delivery</b:ProjectStageName> <b:ProjectStageShortName>Delivery</b:ProjectStageShortName> <b:ProjectStageUid>1152921504606853304</b:ProjectStageUid> </a:ProjectStageIdentity> <a:UnavailableReasonCode i:nil="true"/> <a:Udf1InactiveFlag>false</a:Udf1InactiveFlag> <a:Udf1Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <a:Udf2InactiveFlag>false</a:Udf2InactiveFlag> <a:Udf2Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <a:Udf1DefaultValue i:nil="true"/> <a:Udf2DefaultValue i:nil="true"/> <a:ExpenseTypeIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> </a:ProjectDescriptor> <a:ProjectRateTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsProjectRateTypeSummary> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectRateTypeId i:nil="true"/> <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid> <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName> </b:PwsProjectRateTypeSummary> </a:ProjectRateTypes> <a:ProjectTaskTypes> <a:PwsTaskType> <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectTaskTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectTaskTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608115974</ProjectTaskTypeUid> <a:AllowedProjectRateTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsProjectRateTypeSummary> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectRateTypeId i:nil="true"/> <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid> <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName> </b:PwsProjectRateTypeSummary> </a:AllowedProjectRateTypes> <a:DefaultProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectRateTypeId i:nil="true"/> <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid> </a:DefaultProjectRateTypeIdentity> <a:InactiveFlag>false</a:InactiveFlag> <a:NarrativeRequiredFlag>false</a:NarrativeRequiredFlag> <a:ProjectTaskTypeName>Task Type 01</a:ProjectTaskTypeName> <a:StandardTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:StandardTaskTypeCode>TT01</b:StandardTaskTypeCode> <b:StandardTaskTypeId i:nil="true"/> <b:StandardTaskTypeName>Task Type 01</b:StandardTaskTypeName> <b:StandardTaskTypeUid>1152921504606848772</b:StandardTaskTypeUid> </a:StandardTaskTypeIdentity> </a:PwsTaskType> </a:ProjectTaskTypes> <a:ProjectTasks> <a:PwsProjectTask> <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ProjectTaskId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> </soapenv:Body> </soapenv:Envelope> |
Response Format
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)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetFroTimeCardsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetFroTimeCardsResult <ProjectTaskUid xmlns:a="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608644258</ProjectTaskUid>TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Description i:nil="true"/<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsMessage> <a:Name>Task A1</a:Name> <b:AdditionalErrorText>Message 136: This request was executed against the Development [appdevrc.projectorpsa.com] environment.</b:AdditionalErrorText> <a:Notes/> <b:ErrorCode>NonProductionEnvironment</b:ErrorCode> <a<b:OpenForTimeFlag>true<ErrorNumber>136</ab:OpenForTimeFlag>ErrorNumber> <b:ErrorText>This web service request was executed against a non-production instance <a:ParentProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">of Projector.</b:ErrorText> <b:Type>Information</b:Type> <b:ExternalSystemIdentifierReferenceId1 i:nil="true"/> <b:ProjectTaskIdReferenceId2 i:nil="true"/> </b:PwsMessage> <b:ProjectTaskUid>1152921504608637335</b:ProjectTaskUid> </Messages> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId> </a:ParentProjectTaskIdentity> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc <a:ParentTaskName>Task A</a:ParentTaskName> xmlns="http://projectorpsa.com/CommonServices/">2023-12-01T22:01:20.448959Z</ServerTimestampUtc> <a:PlannedEndDateTime>2018-03-30T08:00:00Z</a:PlannedEndDateTime>NextPageTimecardUidsAfter i:nil="true"/> <a:PwsFroTimeCards> <a:PlannedStartDateTime>2018-03-01T00:00:00Z</a:PlannedStartDateTime> <a:PwsFroTimecardElement> <a:ProjectTaskTypeIdentityApprovedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExternalSystemIdentifier i:nil="true"/> <b:UserDisplayName>Bettina</b:UserDisplayName> <b:ProjectTaskTypeIdUserId i:nil="true"/> <b:UserReferenceSystemId>QA <b:ProjectTaskTypeUid>1152921504608115974<- BB</b:ProjectTaskTypeUid>UserReferenceSystemId> </a:ProjectTaskTypeIdentity><b:UserUid>1152921504607011056</b:UserUid> <a:Roles><b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress> <b:FirstName>Bettina</b:FirstName> <a:PwsProjectTaskRole> <b:LastName>Borces</b:LastName> <ProjectRoleIdentity xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:MiddleName i:nil="true"/> </a:ApprovedByUser> <ExternalSystemIdentifier i:nil="true"/> <a:ApprovedTimestamp>2023-12-01T22:00:58.987Z</a:ApprovedTimestamp> <a:BilledTimestamp>2023-12-01T22:00:58.987Z</a:BilledTimestamp> <ProjectRoleId i:nil="true"/> <a:BillingAdjustmentAmount>0</a:BillingAdjustmentAmount> <ProjectRoleUid>1152921504609522500</ProjectRoleUid><a:ContractLineItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ContractLineItemCode>E001046-CL1</b:ContractLineItemCode> </ProjectRoleIdentity> <b:ContractLineItemId i:nil="true"/> <ProjectTaskIdentity xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ContractLineItemUid>1152921504607303649</b:ContractLineItemUid> </a:ContractLineItemIdentity> <ExternalSystemIdentifier i:nil="true"/> <a:ContractLineItemName>Engagement: For Reporting Only (A)</a:ContractLineItemName> <ProjectTaskId<a:CreatedByUser ixmlns:nilb="true"/> http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>Bettina</b:UserDisplayName> <ProjectTaskUid>1152921504608644258</ProjectTaskUid> <b:UserId i:nil="true"/> </ProjectTaskIdentity> <b:UserReferenceSystemId>QA - BB</b:UserReferenceSystemId> <ProjectTaskRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><b:UserUid>1152921504607011056</b:UserUid> <ProjectTaskRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608549425</ProjectTaskRoleUid> <b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress> <a:ActualMinutesSinceAsOfDate>0</a:ActualMinutesSinceAsOfDate><b:FirstName>Bettina</b:FirstName> <b:LastName>Borces</b:LastName> <a:BudgetedMinutes>10560</a:BudgetedMinutes> <b:MiddleName i:nil="true"/> <a:CompletedFlag>false<</a:CompletedFlag>CreatedByUser> <a:CreatedTimestamp>2023-12-01T22:00:58.987Z</a:CreatedTimestamp> <a:Estimates/> <a:DayFraction>0</a:DayFraction> <a:LateFlag>false</a:LateFlag><a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <a:TotalMinutesToDate>0</a:TotalMinutesToDate><b:CurrencyCode>USD</b:CurrencyCode> <a:CompletedFlagAtLatestPostAsOfDate<b:CurrencyId i:nil="true"/> <b:CurrencyUid>1152921504606851838</b:CurrencyUid> <a:LateEligibleFlag>false</a:LateEligibleFlag> </a:EngagementCurrencyIdentity> <a:LatestAsOfDatePostDateRangeEngagementIdentity ixmlns:nilb="true"/>http://projectorpsa.com/DataContracts/Shared/Common/"> <b:EngagementCode>E001046</b:EngagementCode> <a <b:RemainingMinutesPostDateRangeEngagementId i:nil="true"/> <b:EngagementUid>1152921504607761114</b:EngagementUid> <a:RemainingMinutesPriorToDateRange>10560</a:RemainingMinutesPriorToDateRange> </a:EngagementIdentity> <a:TotalMinutesPostTimesheet>0</aEngagementName>Engagement:TotalMinutesPostTimesheet> For Reporting Only (A)</a:EngagementName> </a:PwsProjectTaskRole><a:FroTimecardDetail> <ReferenceId </a:Roles>i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardId <a:SequenceNumber>1</a:SequenceNumber>i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:WbsCode>1.1</a:WbsCode><TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <a:ParentTaskWbsCode>1</a:ParentTaskWbsCode><TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504749719168</TimecardUid> <<a:AdjustedRevenueAmount>100</a:PwsProjectTask> AdjustedRevenueAmount> </a:ProjectTasks> <a:RoleCount>1<ContractRevenueAmount>100</a:RoleCount>ContractRevenueAmount> <a:TaskCount>2<Description>PwsSaveFroTimeCards</a:TaskCount>Description> <a:TimeCards>:DescriptionClearFlag i:nil="true"/> <a:ExternalGroupingIdentifier>1212023</a:PwsTimecardDetail>ExternalGroupingIdentifier> <ReferenceId<a:ExternalGroupingIdentifierClearFlag i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardId<a:LocationClearFlag i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardType<a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType>> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504646141261</TimecardUid><b:LocationId i:nil="true"/> <a<b:Description>InitialLocationName>USA - research<Illinois</ab:Description>LocationName> <a<b:DescriptionClearFlag>false<LocationUid>1152921504606863508</a:DescriptionClearFlag>b:LocationUid> </a:LocationIdentity> <a:RejectedByUser i:nil="true"ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/><b:ProjectCode>E001046-P001</b:ProjectCode> <a<b:RejectedTimestampProjectId i:nil="true"/>"/> <b:ProjectUid>1152921504607686008</b:ProjectUid> <a:Status>Submitted<</a:Status>ProjectIdentity> <a:WorkDate>2018-03-05T00:00:00Z</a:WorkDate>ProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExternalSystemIdentifier <a:WorkMinutes>480</a:WorkMinutes>i:nil="true"/> <a:Timestamp>AAAAAA64Niw=</a:Timestamp><b:ProjectRateTypeId i:nil="true"/> <a<b:CardStatus>S<ProjectRateTypeUid>1152921504607818384</ab:CardStatus>ProjectRateTypeUid> <a:LocationClearFlag>false<</a:LocationClearFlag> ProjectRateTypeIdentity> <a:LocationIdentityProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:LocationIdExternalSystemIdentifier i:nil="true"/> <b:LocationName>USA</b:LocationName> <b:ProjectRoleId i:nil="true"/> <b:LocationUid>1152921504606855985<ProjectRoleUid>1152921504611115473</b:LocationUid>ProjectRoleUid> </a:LocationIdentity> ProjectRoleIdentity> <a:ProjectIdentityProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ProjectCode>P001395-001</b:ProjectCode> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectIdProjectTaskId i:nil="true"/> <b:ProjectUid>1152921504607412209<ProjectTaskUid>1152921504610341347</b:ProjectUid>ProjectTaskUid> </a:ProjectIdentity> ProjectTaskIdentity> <a:ProjectRateTypeIdentityResourceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">> <b:ResourceDisplayName>Matt</b:ResourceDisplayName> <b:ExternalSystemIdentifierResourceId i:nil="true"/> <b:ProjectRateTypeId i:nil="true"/> ResourceReferenceSystemId>Dev Manager - MJ</b:ResourceReferenceSystemId> <b:ProjectRateTypeUid>1152921504607370460<ResourceUid>1152921504607057128</b:ProjectRateTypeUid> ResourceUid> </a:ProjectRateTypeIdentity>ResourceIdentity> <a:SystemRevenueAmount>100</a:SystemRevenueAmount> <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <a:Timestamp>AAAAADKCBmU=</a:Timestamp> <b<a:ExternalSystemIdentifierUdf1ClearFlag i:nil="true"/> <b<a:ProjectTaskIdUdf1Value ixmlns:nilb="true"/http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ProjectTaskUid>1152921504608644258</b:ProjectTaskUid><b:UdfId i:nil="true"/> <b:UdfName>TC-Text <List</ab:ProjectTaskIdentity>UdfName> <a<b:RoleClearFlag>false<UdfUid>1152921504606864090</ab:RoleClearFlag>UdfUid> <a<b:RoleIdentityBooleanValue xmlnsi:bnil="http://projectorpsa.com/DataContracts/Shared/Common/"> true"/> <b:ExternalSystemIdentifier i:nil="true"/> <b:DataType>L</b:DataType> <b:ProjectRoleIdDateValue i:nil="true"/> <b:ProjectRoleUid>1152921504609522500</b:ProjectRoleUid><b:IntegerValue i:nil="true"/> </a:RoleIdentity><b:ResourceIdentityValue i:nil="true"/> <a<b:Udf1TextValue xmlnsi:bnil="http://projectorpsa.com/DataContracts/Shared/Common/"> "true"/> <b:UdfId i:nil="true"/>UdfTreatment>A</b:UdfTreatment> <b:UdfName>TC-Jira</b:UdfName>StoplightValues/> <b:UdfUid>1152921504606857618</b:UdfUid><b:NumericValue i:nil="true"/> <b:BooleanValueRelationValue i:nil="true"/> <b:DataType>P<StoplightValuesClearFlag>false</b:DataType>StoplightValuesClearFlag> <b:DateValue i:nil="true"/></a:Udf1Value> <b:IntegerValue<a:Udf2ClearFlag i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/<a:Udf2Value xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TextValueUdfId i:nil="true"/> <b:UdfTreatment>A<UdfName>TC-Numeric</b:UdfTreatment>UdfName> <b:StoplightValues/> UdfUid>1152921504606864086</b:UdfUid> <b:NumericValueBooleanValue i:nil="true"/> <b:DataType>I</b:DataType> <b:RelationValue> <b:DateValue i:nil="true"/> <b:CodeValue>SD-23</b:CodeValue> <b:IntegerValue i:nil="true"/> <b:TextValue>2 laptops for demo</b:TextValue> <b:ResourceIdentityValue i:nil="true"/> <b:UidValue>10022</b:UidValue>:TextValue i:nil="true"/> <<b:UdfTreatment>A</b:RelationValue>UdfTreatment> </a:Udf1><b:StoplightValues/> <a:Udf1ClearFlag>false</a:Udf1ClearFlag><b:NumericValue i:nil="true"/> <a<b:Udf2RelationValue xmlnsi:bnil="http://projectorpsa.com/DataContracts/Shared/Common/">"true"/> <b:StoplightValuesClearFlag>false</b:StoplightValuesClearFlag> <b:UdfId i:nil="true"/> </a:Udf2Value> <b<a:UdfName>TC-Zendesk</b:UdfName>WorkDate>2023-11-06T00:00:00Z</a:WorkDate> <a:WorkMinutes>45</a:WorkMinutes> <b:UdfUid>1152921504606857619</b:UdfUid> </a:FroTimecardDetail> <b<a:BooleanValueLastUpdatedByUser ixmlns:nilb="true"/> http://projectorpsa.com/DataContracts/Shared/Common/"> <b:DataType>P<UserDisplayName>Bettina</b:DataType> UserDisplayName> <b:DateValueUserId i:nil="true"/> <b:IntegerValue i:nil="true"/> UserReferenceSystemId>QA - BB</b:UserReferenceSystemId> <b:ResourceIdentityValue i:nil="true"/> UserUid>1152921504607011056</b:UserUid> <b:TextValue i:nil="true"/>EmailAddress>bettina@projectorpsa.com</b:EmailAddress> <b:UdfTreatment>A<FirstName>Bettina</b:UdfTreatment> FirstName> <b:StoplightValues/> LastName>Borces</b:LastName> <b:NumericValueMiddleName i:nil="true"/> </a:LastUpdatedByUser> <b:RelationValue i:nil="true"/> <a:LastUpdatedTimestamp>2023-12-01T22:00:58.987Z</a:LastUpdatedTimestamp> </a:Udf2> <a:ProjectName>Engagement: For Reporting Only (A)</a:ProjectName> <a:Udf2ClearFlag>false<ProjectTaskFullWbsCode>1</a:Udf2ClearFlag>ProjectTaskFullWbsCode> <a:ExternalGroupingIdentifierProjectTaskTypeIdentity ixmlns:nilb="true"/http://projectorpsa.com/DataContracts/Shared/Common/"> <a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag><b:ExternalSystemIdentifier i:nil="true"/> </a:PwsTimecardDetail><b:ProjectTaskTypeId i:nil="true"/> <<b:ProjectTaskTypeUid>1152921504609305356</ab:TimeCards>ProjectTaskTypeUid> <a:Udf1Treatment>A<</a:Udf1Treatment>ProjectTaskTypeIdentity> <a:Udf2Treatment>A<RevRecAdjustmentAmount>0</a:Udf2Treatment> </a:PwsTimeEntryProject>RevRecAdjustmentAmount> </a:TimeEntryProjects>PwsFroTimecardElement> <a:TimeEntryTimeOff/></a:PwsFroTimeCards> </PwsGetTimeCardsResult>PwsGetFroTimeCardsResult> </PwsGetTimeCardsResponse>PwsGetFroTimeCardsResponse> </s:Body> </s:Envelope> |
...
PwsGetFroTimeCards - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber |
---|
ErrorCode
ErrorText
ErrorCode | ErrorText | |
---|---|---|
10119 | ValueBelowMinimum | The value specified in the field "MaximumResults" in the class "PwsGetFroTimeCardsRq" is out of range. The value must not be less than 1. |
50024 | EntityNotFound | Contract 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. |
64249 | SpecifiedDateRangeMissingIncompleteOrInvalid | A 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. |