Overview
...
Overview
This method is ued to retrieve a resource's time off information. It includes the resource's past, future time requested, resource's reported time off and future holiday time off data.
Request Format
Panel | ||
---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description |
---|---|---|---|---|
Int32 | No | Click here for more information. | ||
String | Yes | Click here for more information. | ||
CutoffDate | DateTime | No | The end of last week | ??? |
IncludePastRequestedTimeOffFlag | Boolean | No | If set to true, past requested time offs are included in the response. | |
ResourceIdentity | Yes | This structure represents the unique key fields associated with identifying a resource. |
Request Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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:PwsGetResourcePto>
<!--Optional:-->
<pws:serviceRequest>
<req:SessionTicket>AQs/cc+1ncna6N2MJvgt7Q==</req:SessionTicket>
<!--Optional:-->
<!--tim:CutoffDate>?</tim:CutoffDate-->
<!--Optional:-->
<tim:IncludePastRequestedTimeOffFlag>1</tim:IncludePastRequestedTimeOffFlag>
<!--Optional:-->
<tim:ResourceIdentity>
<com:ResourceReferenceSystemId>ID-EM</com:ResourceReferenceSystemId>
</tim:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsGetResourcePto>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
Panel | ||
---|---|---|
| ||
|
...
Element | Data Type | Description |
---|---|---|
Messages | The web service response status and message. Click here for more information. | |
Int32 | Click here for more information. | |
RequestStatus | Click here for more information. | |
DateTime | Click here for more information. | |
CutoffDate | DateTime | ??? |
HistoricalReportedTimeOffs | This data structure captures the details of a reported time off. | |
ScheduledHolidaysFuture | This data structure contains the resource's future holiday time off details. | |
ScheduledTimeOffFuture | This data structure captures details of the scheduled time off in the future. | |
ScheduledTimeOffPast | This data structure captures details of the scheduled time off in the past. | |
SchedulingGranularityMinutes | Int32 | The installation's scheduling granuality in minutes. |
TimeOffReasons | This data structure contains the details about one time off reason for a resource |
Response Usage Example(s)
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetResourcePtoResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetResourcePtoResult 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/"> <b:PwsMessage> <b:AdditionalErrorText>Message 136: This request was executed against the Staging [appst.projectorpsa.com] environment.</b:PwsCostCenterPermissionSettingElement>/b:AdditionalErrorText> <b:ErrorCode>NonProductionEnvironment</b:ErrorCode> <b:ErrorNumber>136</b:ErrorNumber> <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText> <b:Type>Information</b:Type> <b:ReferenceId1 i:nil="true"/> <b:ReferenceId2 i:nil="true"/> </b:PwsMessage> </Messages> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-08-22T18:31:11.4754285Z</ServerTimestampUtc> <a:CutoffDate>2022-08-20T00:00:00Z</a:CutoffDate> <a:HistoricalReportedTimeOffs> <a:PwsHistoricalReportedTimeOff> <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">R</TimecardType> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609106129</TimecardUid> <a:Description i:nil="true"/> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:WorkDate>2022-07-05T00:00:00</a:WorkDate> <a:WorkMinutes>450</a:WorkMinutes> </a:PwsHistoricalReportedTimeOff> <a:PwsHistoricalReportedTimeOff> <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">R</TimecardType> <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609106130</TimecardUid> <a:Description i:nil="true"/> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:WorkDate>2022-07-06T00:00:00</a:WorkDate> <a:WorkMinutes>450</a:WorkMinutes> </a:PwsHistoricalReportedTimeOff> </a:HistoricalReportedTimeOffs> <a:ScheduledHolidaysFuture> <a:PwsHolidayPto> <a:Date>2022-11-24T00:00:00</a:Date> <a:EffectiveTimeOffMinutes>600</a:EffectiveTimeOffMinutes> <a:Name>Thanksgiving</a:Name> <a:TimeOffMinutes>1440</a:TimeOffMinutes> </a:PwsHolidayPto> <a:PwsHolidayPto> <a:Date>2022-11-25T00:00:00</a:Date> <a:EffectiveTimeOffMinutes>600</a:EffectiveTimeOffMinutes> <a:Name>Post Thanksgiving</a:Name> <a:TimeOffMinutes>1440</a:TimeOffMinutes> </a:PwsHolidayPto> </a:ScheduledHolidaysFuture> <a:ScheduledTimeOffFuture> <a:PwsScheduledTimeOffPto> <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591579</ScheduledTimeOffUid> <a:ApprovalStatus>A</a:ApprovalStatus> <a:BeginDate>2022-09-06T00:00:00</a:BeginDate> <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes> <a:EffectiveTimeOffMinutes>600</a:EffectiveTimeOffMinutes> <a:EndDate>2022-09-06T00:00:00</a:EndDate> <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp>0001-01-01T00:00:00</a:RejectedTimestamp> <a:TimeOffComment i:nil="true"/> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:Timestamp>AAAAAB9q2nU=</a:Timestamp> </a:PwsScheduledTimeOffPto> <a:PwsScheduledTimeOffPto> <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591580</ScheduledTimeOffUid> <a:ApprovalStatus>R</a:ApprovalStatus> <a:BeginDate>2022-12-27T00:00:00</a:BeginDate> <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes> <a:EffectiveTimeOffMinutes>600</a:EffectiveTimeOffMinutes> <a:EndDate>2022-12-27T00:00:00</a:EndDate> <a:RejectedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>PPSA Support User</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>000</b:UserReferenceSystemId> <b:UserUid>1152921504606944261</b:UserUid> <b:EmailAddress>support@projectorpsa.com</b:EmailAddress> <b:FirstName>PPSA Support User</b:FirstName> <b:LastName>PPSA Support User</b:LastName> <b:MiddleName>PPSA Support User</b:MiddleName> </a:RejectedByUser> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp>2022-08-22T17:11:30.21Z</a:RejectedTimestamp> <a:TimeOffComment>Post Xmas + 1</a:TimeOffComment> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:Timestamp>AAAAAB9q2rg=</a:Timestamp> </a:PwsScheduledTimeOffPto> <a:PwsScheduledTimeOffPto> <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591581</ScheduledTimeOffUid> <a:ApprovalStatus>P</a:ApprovalStatus> <a:BeginDate>2022-12-28T00:00:00</a:BeginDate> <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes> <a:EffectiveTimeOffMinutes>3600</a:EffectiveTimeOffMinutes> <a:EndDate>2023-01-04T00:00:00</a:EndDate> <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp>0001-01-01T00:00:00</a:RejectedTimestamp> <a:TimeOffComment>Post Xmas + 2</a:TimeOffComment> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:Timestamp>AAAAAB9q2r4=</a:Timestamp> </a:PwsScheduledTimeOffPto> </a:ScheduledTimeOffFuture> <a:ScheduledTimeOffPast> <a:PwsScheduledTimeOff> <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591579</ScheduledTimeOffUid> <a:ApprovalStatus>A</a:ApprovalStatus> <a:BeginDate>2022-09-06T00:00:00</a:BeginDate> <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes> <a:EffectiveTimeOffMinutes>600</a:EffectiveTimeOffMinutes> <a:EndDate>2022-09-06T00:00:00</a:EndDate> <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp>0001-01-01T00:00:00</a:RejectedTimestamp> <a:TimeOffComment i:nil="true"/> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:Timestamp>AAAAAB9q2nU=</a:Timestamp> </a:PwsScheduledTimeOff> <a:PwsScheduledTimeOff> <ScheduledTimeOffId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ScheduledTimeOffUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607591581</ScheduledTimeOffUid> <a:ApprovalStatus>P</a:ApprovalStatus> <a:BeginDate>2022-12-28T00:00:00</a:BeginDate> <a:DailyTimeOffMinutes>1440</a:DailyTimeOffMinutes> <a:EffectiveTimeOffMinutes>1800</a:EffectiveTimeOffMinutes> <a:EndDate>2023-01-04T00:00:00</a:EndDate> <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:RejectedReason i:nil="true"/> <a:RejectedTimestamp>0001-01-01T00:00:00</a:RejectedTimestamp> <a:TimeOffComment>Post Xmas + 2</a:TimeOffComment> <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:TimeOffReasonId i:nil="true"/> <b:TimeOffReasonName>Vacation</b:TimeOffReasonName> <b:TimeOffReasonUid>1152921504606854584</b:TimeOffReasonUid> </a:TimeOffReasonIdentity> <a:TimeOffYear>2022</a:TimeOffYear> <a:Timestamp>AAAAAB9q2r4=</a:Timestamp> </a:PwsScheduledTimeOff> </a:ScheduledTimeOffPast> <a:SchedulingGranularityMinutes>6</a:SchedulingGranularityMinutes> <a:TimeOffReasons> <a:PwsTimeOffReasonPto> <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/">1152921504606854584</TimeOffReasonUid> <a:InactiveFlag>false</a:InactiveFlag> <a:SortOrder>0</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear>0</a:AvailableMinutesAtEndOfLastYear> <a:AvailableMinutesAtEndOfThisYear>6600</a:AvailableMinutesAtEndOfThisYear> <a:LastYearInactiveFlag>false</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>false</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>false</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> <a:PwsTimeOffReasonPto> <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/">1152921504606854581</TimeOffReasonUid> <a:InactiveFlag>false</a:InactiveFlag> <a:SortOrder>1</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear i:nil="true"/> <a:AvailableMinutesAtEndOfThisYear i:nil="true"/> <a:LastYearInactiveFlag>false</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>false</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>false</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> <a:PwsTimeOffReasonPto> <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Personal Day</TimeOffReasonName> <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606854583</TimeOffReasonUid> <a:InactiveFlag>false</a:InactiveFlag> <a:SortOrder>2</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear i:nil="true"/> <a:AvailableMinutesAtEndOfThisYear i:nil="true"/> <a:LastYearInactiveFlag>false</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>false</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>false</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> <a:PwsTimeOffReasonPto> <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Jury Duty</TimeOffReasonName> <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606854582</TimeOffReasonUid> <a:InactiveFlag>false</a:InactiveFlag> <a:SortOrder>3</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear i:nil="true"/> <a:AvailableMinutesAtEndOfThisYear i:nil="true"/> <a:LastYearInactiveFlag>false</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>false</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>false</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> <a:PwsTimeOffReasonPto> <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Inactive Reason Day</TimeOffReasonName> <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606862272</TimeOffReasonUid> <a:InactiveFlag>true</a:InactiveFlag> <a:SortOrder>4</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear>0</a:AvailableMinutesAtEndOfLastYear> <a:AvailableMinutesAtEndOfThisYear>0</a:AvailableMinutesAtEndOfThisYear> <a:LastYearInactiveFlag>true</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>true</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>true</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> <a:PwsTimeOffReasonPto> <TimeOffReasonId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <TimeOffReasonName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Family Health Day</TimeOffReasonName> <TimeOffReasonUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606868296</TimeOffReasonUid> <a:InactiveFlag>false</a:InactiveFlag> <a:SortOrder>5</a:SortOrder> <a:ReportedTimeOffDescriptionRequiredFlag>false</a:ReportedTimeOffDescriptionRequiredFlag> <a:ScheduledTimeOffDescriptionRequiredFlag>false</a:ScheduledTimeOffDescriptionRequiredFlag> <a:AvailableMinutesAtEndOfLastYear>0</a:AvailableMinutesAtEndOfLastYear> <a:AvailableMinutesAtEndOfThisYear>0</a:AvailableMinutesAtEndOfThisYear> <a:LastYearInactiveFlag>false</a:LastYearInactiveFlag> <a:PostCutoffInactiveFlag>false</a:PostCutoffInactiveFlag> <a:ThisYearInactiveFlag>false</a:ThisYearInactiveFlag> </a:PwsTimeOffReasonPto> </a:TimeOffReasons> </PwsGetResourcePtoResult> </PwsGetResourcePtoResponse> </s:Body> </s:Envelope> |
PwsSaveUser - Common Errors and Warnings
...