Overview

This web service retrieves a list of client element records (PwsClientDetail), based upon a unique resource identifier (PwsResourceRef)/\.

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

PwsGetResourceUtilizationSummaryRq
- RequestId: Int32
- SessionTicket: String
- IncludeSubmittedTimeFlag: Boolean
- ResourceIdentity: PwsResourceRef

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	`AQAXIgeu3zqNKQ0tJ2+nww==`
IncludeSubmittedTimeFlag	Boolean	No	false	If set to 'true' submitted time will be factored into the utilization	`true`
ResourceIdentity	PwsResourceRef	Yes		This is the identify of the resource

Request Usage Example(s)

<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:PwsGetResourceUtilizationSummary>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AQAXIgeu3zqNKQ0tJ2+nww==</req:SessionTicket>
            <tim:IncludeSubmittedTimeFlag>true</tim:IncludeSubmittedTimeFlag>
            <tim:ResourceIdentity>
               <com:ResourceDisplayName>Matt</com:ResourceDisplayName>
            </tim:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsGetResourceUtilizationSummary>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetResourceUtilizationSummaryRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- TimeOffSummary: PwsTimeOffSummary[]
- UtilizationSummaryPackage: PwsUtilizationSummaryPackage

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
Status	RequestStatus	Click here for more information
ServerTimestampUtc	DateTime	Click here for more information
TimeOffSummary	PwsTimeOffSummary[]
UtilizationSummaryPackage	PwsUtilizationSummaryPackage

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetResourceUtilizationSummaryResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <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:23:32.9648128Z</ServerTimestampUtc>
            <a:TimeOffSummary>
               <a:PwsTimeOffSummary>
                  <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Vacation</TimeOffReasonName>
                  <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606858293</TimeOffReasonUid>
                  <a:LastYearMinutes>4320</a:LastYearMinutes>
                  <a:SortOrder>148</a:SortOrder>
                  <a:ThisYearMinutes>0</a:ThisYearMinutes>
               </a:PwsTimeOffSummary>
               <a:PwsTimeOffSummary>
                  <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Illness</TimeOffReasonName>
                  <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606858294</TimeOffReasonUid>
                  <a:LastYearMinutes>0</a:LastYearMinutes>
                  <a:SortOrder>156</a:SortOrder>
                  <a:ThisYearMinutes>240</a:ThisYearMinutes>
               </a:PwsTimeOffSummary>
            </a:TimeOffSummary>
            <a:UtilizationSummaryPackage>
               <a:LastYearUtilization>
                  <a:BillableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:BillableUtilizationAndTarget>
                  <a:ChargeableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ChargeableUtilizationAndTarget>
                  <a:OverMaximum>
                     <a:Color>#0000FF</a:Color>
                     <a:Symbol>▲</a:Symbol>
                  </a:OverMaximum>
                  <a:ProductiveUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ProductiveUtilizationAndTarget>
                  <a:TotalUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</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>2024</a:Year>
               </a:LastYearUtilization>
               <a:ThisYearUtilization>
                  <a:BillableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:BillableUtilizationAndTarget>
                  <a:ChargeableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ChargeableUtilizationAndTarget>
                  <a:OverMaximum>
                     <a:Color>#0000FF</a:Color>
                     <a:Symbol>▲</a:Symbol>
                  </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.