Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This web service retrieves an installation's employee dashboard parameters (PwsDashboardParameters), based upon a unique SessionTicket

Request Format


PwsGetDashboardParameters Request

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

Response Elements


Element

Data Type

Description

Sample Data

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

  • No labels