Overview
This web service retrieves a list of cost cards (PwsVersionedTimeCardRef client element records (PwsClientDetail), based upon an external grouping identifiera unique resource identifier (PwsResourceRef)/\.
Info |
---|
Rate 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
PwsGetTimeCardsByExternalGroupingIdentifier
serviceRequest: PwsGetTimeCardsByExternalGroupingIdentifierRqPwsGetResourceUtilizationSummaryRq
RequestId: Int32
SessionTicket: String
ExternalGroupingIdentifiers- : Int32[]
IncludeSubmittedTimeFlag: Boolean
ResourceIdentity: PwsResourceRef
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Int32 | No | Click here for more information |
| ||||
String | Yes | Click here for more information |
|
IncludeSubmittedTimeFlag |
1
Boolean |
Yes
The external grouping identifier for one or more time cards.
No | false | If set to 'true' submitted time will be factored into the utilization |
| ||
ResourceIdentity | Yes | This is the identify of the resource |
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:arrcom="http://schemas.microsoftprojectorpsa.com/2003DataContracts/10Shared/SerializationCommon/Arrays"> <soapenv:Header/> <soapenv:Body> <pws:PwsGetTimeCardsByExternalGroupingIdentifier>PwsGetResourceUtilizationSummary> <pws:serviceRequest> <req:RequestId>1</req:RequestId> <req:SessionTicket>AQAXIgeu3zqNKQ0tJ2+nww==</req:SessionTicket> <tim:ExternalGroupingIdentifiers>IncludeSubmittedTimeFlag>true</tim:IncludeSubmittedTimeFlag> <tim:ResourceIdentity> <arr:int>1</arr:int> <com:ResourceDisplayName>Matt</com:ResourceDisplayName> </tim:ExternalGroupingIdentifiers>ResourceIdentity> </pws:serviceRequest> </pws:PwsGetTimeCardsByExternalGroupingIdentifier>PwsGetResourceUtilizationSummary> </soapenv:Body> </soapenv:Envelope> |
Response Format
PwsGetTimeCardsByExternalGroupingIdentifierResponsePwsGetResourceUtilizationSummaryRs
PwsGetTimeCardsByExternalGroupingIdentifierResult: PwsGetTimeCardsByExternalGroupingIdentifierRs
Messages: PwsMessage[]
ResponseId: Int32
Status: RequestStatus
ServerTimestampUtc: DateTime
- TimeCards
TimeOffSummary:
PwsVersionedTimecardRef UtilizationSummaryPackage: PwsUtilizationSummaryPackage
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information |
1
Status | Click here for more information |
Ok
ServerTimestampUtc | DateTime | Click here for more information |
2025-02-10T19:59:05.9787755Z
TimeCards
TimeOffSummary | |||
UtilizationSummaryPackage |
Response Usage Example(s)
Code Block |
---|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetTimeCardsByExternalGroupingIdentifierResponse<PwsGetResourceUtilizationSummaryResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetTimeCardsByExternalGroupingIdentifierResult<PwsGetResourceUtilizationSummaryResult 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/">2025-02-10T20:1523:4032.0868569Z<9648128Z</ServerTimestampUtc> <a:TimeCards>TimeOffSummary> <a:PwsVersionedTimecardRef>PwsTimeOffSummary> <ReferenceId<TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId>> <TimecardId<TimeOffReasonName i:nilxmlns="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Vacation</>TimeOffReasonName> <TimecardType<TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T<>1152921504606858293</TimecardType>TimeOffReasonUid> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504648112199</TimecardUid><a:LastYearMinutes>4320</a:LastYearMinutes> <a:Timestamp>AAAAADaXPWU=<SortOrder>148</a:Timestamp>SortOrder> <<a:ThisYearMinutes>0</a:PwsVersionedTimecardRef>ThisYearMinutes> <a</a:PwsVersionedTimecardRef>PwsTimeOffSummary> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId><a:PwsTimeOffSummary> <TimecardId<TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardType<TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T<>Illness</TimecardType>TimeOffReasonName> <TimecardUid<TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504652319420<>1152921504606858294</TimecardUid>TimeOffReasonUid> <a:Timestamp>AAAAABlXIzA=<LastYearMinutes>0</a:Timestamp>LastYearMinutes> </a:PwsVersionedTimecardRef> <a:SortOrder>156</a:SortOrder> <a:PwsVersionedTimecardRef>ThisYearMinutes>240</a:ThisYearMinutes> </a:PwsTimeOffSummary> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId> </a:TimeOffSummary> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><a:UtilizationSummaryPackage> <a:LastYearUtilization> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <a:BillableUtilizationAndTarget> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504652319651</TimecardUid> <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent> <a:Timestamp>AAAAABlXIzI=</a:Timestamp> <<a:MaximumTargetPercent>1</a:PwsVersionedTimecardRef>MaximumTargetPercent> <a:PwsVersionedTimecardRef>:MinimumTargetPercent>0.8</a:MinimumTargetPercent> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId></a:BillableUtilizationAndTarget> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><a:ChargeableUtilizationAndTarget> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType><a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent> <TimecardUid xmlns="http<a://projectorpsa.com/DataContracts/Shared/Common/">1152921504652319652</TimecardUid>MaximumTargetPercent>1</a:MaximumTargetPercent> <a:Timestamp>AAAAABlXI4A=<MinimumTargetPercent>0.8</a:Timestamp>MinimumTargetPercent> </a:PwsVersionedTimecardRef>ChargeableUtilizationAndTarget> <a:PwsVersionedTimecardRef>OverMaximum> <ReferenceId xmlns="http<a://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId>Color>#0000FF</a:Color> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:Symbol>▲</a:Symbol> </a:OverMaximum> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <a:ProductiveUtilizationAndTarget> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504652319653</TimecardUid> <a:Timestamp>AAAAABlXI4Y=<ActualUtilizationPercent>0.15562248995983935</a:Timestamp>ActualUtilizationPercent> <<a:MaximumTargetPercent>1</a:PwsVersionedTimecardRef>MaximumTargetPercent> <a:PwsVersionedTimecardRef>MinimumTargetPercent>0.8</a:MinimumTargetPercent> </a:ProductiveUtilizationAndTarget> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><a:TotalUtilizationAndTarget> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent> <TimecardUid xmlns="http<a://projectorpsa.com/DataContracts/Shared/Common/">1152921504652319654</TimecardUid>MaximumTargetPercent>1</a:MaximumTargetPercent> <a:Timestamp>AAAAABlXI4k=<MinimumTargetPercent>0.8</a:Timestamp>MinimumTargetPercent> </a:PwsVersionedTimecardRef>TotalUtilizationAndTarget> <a:PwsVersionedTimecardRef>UnderMinimum> <ReferenceId xmlns="http<a://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId>Color>#FF0000</a:Color> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:Symbol>▼</a:Symbol> </a:UnderMinimum> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <a:WithinRange> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504657532411</TimecardUid> <a:Color>#FF00FF</a:Color> <a:Timestamp>AAAAADdhptI=<Symbol>■</a:Timestamp>Symbol> </a:PwsVersionedTimecardRef>WithinRange> <a:PwsVersionedTimecardRef> <a:Year>2024</a:Year> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId></a:LastYearUtilization> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><a:ThisYearUtilization> <a:BillableUtilizationAndTarget> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504658071128</TimecardUid><a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent> <a:Timestamp>AAAAABovEPM=<MaximumTargetPercent>1</a:Timestamp>MaximumTargetPercent> <<a:MinimumTargetPercent>0.8</a:PwsVersionedTimecardRef>MinimumTargetPercent> <a</a:PwsVersionedTimecardRef>BillableUtilizationAndTarget> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId><a:ChargeableUtilizationAndTarget> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/><a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent> <TimecardType xmlns="http<a://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType>MaximumTargetPercent>1</a:MaximumTargetPercent> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504749602726</TimecardUid><a:MinimumTargetPercent>0.8</a:MinimumTargetPercent> <a:Timestamp>AAAAADPRUKE=</a:Timestamp>ChargeableUtilizationAndTarget> </a:PwsVersionedTimecardRef><a:OverMaximum> <<a:Color>#0000FF</a:TimeCards>Color> </PwsGetTimeCardsByExternalGroupingIdentifierResult> </PwsGetTimeCardsByExternalGroupingIdentifierResponse> <<a:Symbol>▲</s:Body>a:Symbol> </s:Envelope> |
PwsGetTimeCardsByExternalGroupingIdentifier - Common Errors and Warnings
...
a:OverMaximum>
<a:ProductiveUtilizationAndTarget>
<a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
<a:MaximumTargetPercent>1</a:MaximumTargetPercent>
<a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
</a:ProductiveUtilizationAndTarget>
<a:TotalUtilizationAndTarget>
<a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
<a:MaximumTargetPercent>1</a:MaximumTargetPercent>
<a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
</a:TotalUtilizationAndTarget>
<a:UnderMinimum>
<a:Color>#FF0000</a:Color>
<a:Symbol>▼</a:Symbol>
</a:UnderMinimum>
<a:WithinRange>
<a:Color>#FF00FF</a:Color>
<a:Symbol>■</a:Symbol>
</a:WithinRange>
<a:Year>2025</a:Year>
</a:ThisYearUtilization>
<a:ShowUtilizationFlag>true</a:ShowUtilizationFlag>
</a:UtilizationSummaryPackage>
</PwsGetResourceUtilizationSummaryResult>
</PwsGetResourceUtilizationSummaryResponse>
</s:Body>
</s:Envelope> |
PwsGetResourceUtilizationSummary - Common Errors and Warnings
For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
1103 | NoClientsSpecified | No clients were specified for retrieval by this request. |
11040 | MaximumClientIdentitiesExceeded | Please specify between 1 and 100 client identities for retrieval. |
50045 | ViewPermissionDenied | You do not have permission to view this item. |
57631 | ClientNotSpecified | A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number. |
57634 | UnexpectedErrorRetrievingClients | There was an unexpected error while trying to retrieve a client. |