Versions Compared

Key

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

...

This web service retrieves an installation's time entry parameters (i.e. first day of week, grouping, user defined fields, etc.)PwsTimeEntryParameters). The time entry parameters are a collection of Projector settings that are related to time entry.

Request Format


Panel
titlePwsGetTimeEntryParameters 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.

ARgBFuS/0LDcPCTXeih6XQ==

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:PwsGetTimeEntryParameters>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>ARgBFuS/0LDcPCTXeih6XQ==</req:SessionTicket>
         </pws:serviceRequest>
      </pws:PwsGetTimeEntryParameters>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsGetTimeEntryParameters 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.

1

Status

RequestStatus

Click here for more information.

Ok 

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-12T19:44:18.4722759Z

Parameters

PwsTimeEntryParameters

The time entry parameters for this installation.


Response Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetTimeEntryParametersResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetTimeEntryParametersResult 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-12T19:44:18.4722759Z</ServerTimestampUtc>
            <a:Parameters>
               <a:FirstDayOfWeek>Sunday</a:FirstDayOfWeek>
               <a:Level1Grouping i:nil="true"/>
               <a:Level2Grouping i:nil="true"/>
               <a:MissingTimeBasisWeeklyFlag>false</a:MissingTimeBasisWeeklyFlag>
               <a:PercentCompleteGranularity>25</a:PercentCompleteGranularity>
               <a:ProjectFormatString>{ProjectCode}</a:ProjectFormatString>
               <a:ReportingTimeIncrement>15</a:ReportingTimeIncrement>
               <a:RequireLocationFlag>false</a:RequireLocationFlag>
               <a:RequireNotificationFlag>false</a:RequireNotificationFlag>
               <a:ShowToDateValuesFlag>true</a:ShowToDateValuesFlag>
               <a:TimeEntryFormat>Decimal</a:TimeEntryFormat>
               <a:TimeOffReasons/>
               <a:Udf1>
                  <a:UdfDatatype>P</a:UdfDatatype>
                  <a:UdfRequiredFlag>false</a:UdfRequiredFlag>
                  <a:UdfValues xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                  <a:UdfIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UdfId i:nil="true"/>
                     <b:UdfName>TC-Jira</b:UdfName>
                     <b:UdfUid>1152921504606857618</b:UdfUid>
                  </a:UdfIdentity>
                  <a:UdfConnectorCode>JIRA2</a:UdfConnectorCode>
                  <a:UdfDetailSubstitutionCode>C</a:UdfDetailSubstitutionCode>
                  <a:UdfItemDetailPageUrl>https://projectorpsa.atlassian.net/browse/{0}</a:UdfItemDetailPageUrl>
                  <a:DecimalDigits i:nil="true"/>
               </a:Udf1>
               <a:Udf2>
                  <a:UdfDatatype>P</a:UdfDatatype>
                  <a:UdfRequiredFlag>false</a:UdfRequiredFlag>
                  <a:UdfValues xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                  <a:UdfIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UdfId i:nil="true"/>
                     <b:UdfName>TC-Zendesk</b:UdfName>
                     <b:UdfUid>1152921504606857619</b:UdfUid>
                  </a:UdfIdentity>
                  <a:UdfConnectorCode>ZENDESK2</a:UdfConnectorCode>
                  <a:UdfDetailSubstitutionCode>U</a:UdfDetailSubstitutionCode>
                  <a:UdfItemDetailPageUrl>https://projector.zendesk.com/agent/tickets/{0}</a:UdfItemDetailPageUrl>
                  <a:DecimalDigits i:nil="true"/>
               </a:Udf2>
               <a:Enforce24HourDailyLimitFlag>false</a:Enforce24HourDailyLimitFlag>
               <a:OboPermissionFlag>false</a:OboPermissionFlag>
               <a:ResourcesCanUpdateHtgFlag>true</a:ResourcesCanUpdateHtgFlag>
            </a:Parameters>
         </PwsGetTimeEntryParametersResult>
      </PwsGetTimeEntryParametersResponse>
   </s:Body>
</s:Envelope>


PwsGetTimeEntryParameters - Common Errors and Warnings

...

...

ErrorNumber

...

ErrorCode

...

ErrorText

...