Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This web service retrieves an installation's employee dashboard parameters (PwsDashboardParameters), based upon a unique SessionTicket. 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.

Request Format


Panel
titlePwsGetDashboardParameters 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)


Code Block
languagexml
titleExample 01
collapsetrue
<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>

...

Panel
titlePwsGetDashboardParameters 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)

...

ErrorNumberErrorCodeErrorText
-101InvalidSessionThe specified session is not valid or is no longer valid. Please re-establish a session.