Overview

This web service retrieves an installation's employee dashboard parameters (PwsDashboardParameters). The dashboard parameters are a collection of various settings pertaining to the account or the specific caller related to the content on the Projector Web dashboard page.

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

PwsGetDashboardParameters Request

PwsGetDashboardParameters
- serviceRequest: PwsGetDashboardParametersRq
  - RequestId: Int32
  - SessionTicket: String

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	1
SessionTicket	String	Yes	Click here for more information.	AbHODMrb8ng+PCV+B7BzmQ==

Request Usage Example(s)

Example 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetDashboardParameters>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbHODMrb8ng+PCV+B7BzmQ==</req:SessionTicket>
         </pws:serviceRequest>
      </pws:PwsGetDashboardParameters>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetDashboardParameters Response

PwsGetDashboardParametersResponse
- PwsGetDashboardParametersResult: PwsGetDashboardParametersRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Parameters: PwsDashboardParameters

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
Parameters	PwsDashboardParameters	The employee dashboard parameters associated with the installation

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetDashboardParametersResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDashboardParametersResult 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/">2018-03-15T20:33:33.6792656Z</ServerTimestampUtc>
            <a:Parameters>
               <a:FirstDayOfWeek>Sunday</a:FirstDayOfWeek>
               <a:Level1Grouping i:nil="true"/>
               <a:Level2Grouping i:nil="true"/>
               <a:ProjectFormatString>{ProjectCode}</a:ProjectFormatString>
               <a:ShowNotesFlag>true</a:ShowNotesFlag>
               <a:ShowUtilizationFlag>false</a:ShowUtilizationFlag>
               <a:ShowTimeOffToDateValuesFlag>true</a:ShowTimeOffToDateValuesFlag>
               <a:EnterCostFlag>false</a:EnterCostFlag>
               <a:EnterTimeFlag>false</a:EnterTimeFlag>
               <a:ExpenseEntryOboPermissionFlag>true</a:ExpenseEntryOboPermissionFlag>
               <a:OboPermissionFlag>true</a:OboPermissionFlag>
               <a:TimeEntryOboPermissionFlag>true</a:TimeEntryOboPermissionFlag>
               <a:TimeOffOboPermissionFlag>true</a:TimeOffOboPermissionFlag>
            </a:Parameters>
         </PwsGetDashboardParametersResult>
      </PwsGetDashboardParametersResponse>
   </s:Body>
</s:Envelope>

PwsGetDashboardParameters - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
-101	InvalidSession	The specified session is not valid or is no longer valid. Please re-establish a session.

API Documentation

PwsGetDashboardParameters

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetDashboardParameters - Common Errors and Warnings

Related content

PwsGetDashboardParameters

[data-colorid=kht5ccp9il]{color:#292a2e} html[data-color-mode=dark] [data-colorid=kht5ccp9il]{color:#d1d2d6}[data-colorid=b23ag00qhd]{color:#292a2e} html[data-color-mode=dark] [data-colorid=b23ag00qhd]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetDashboardParameters - Common Errors and Warnings

Related content

Overview