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

« Previous Version 3 Next »

Overview


This web service retrieves a list of resource records (PwsResourceElement), based upon a list of unique resource identifiers (PwsResourceRef). 

Request Format


PwsGetResource 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

AbdejNOthGTuJG6gQv4pNg==

ResourceIdentities

PwsResourceRef[1..100]

Yes 

One or more (up to 100) resource to be retrieved


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/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetResource>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbdejNOthGTuJG6gQv4pNg==</req:SessionTicket>
            <req:ResourceIdentities>
               <com:PwsResourceRef>
                  <com:ResourceDisplayName>Web Services</com:ResourceDisplayName>
                  <com:ResourceReferenceSystemId>WS01</com:ResourceReferenceSystemId>
               </com:PwsResourceRef>
            </req:ResourceIdentities>
         </pws:serviceRequest>
      </pws:PwsGetResource>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetResource 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-10-17T18:57:56.8068933Z

Resources

PwsResourceElement[1..100]

The details of the contract line items that were fetched


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetResourceResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetResourceResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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-10-17T18:57:56.8068933Z</ServerTimestampUtc>
            <a:Resources xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsResourceElement>
                  <b:ActiveHistoryIndex>0</b:ActiveHistoryIndex>
                  <b:History>
                     <b:PwsResourceHistory>
                        <b:BeginDate>2018-10-01T00:00:00Z</b:BeginDate>
                        <b:EndDate i:nil="true"/>
                        <b:Record>
                           <b:ActualHolidaysFlag>true</b:ActualHolidaysFlag>
                           <b:AllowApproveOwnTimecardsFlag>true</b:AllowApproveOwnTimecardsFlag>
                           <b:BillableFlag>true</b:BillableFlag>
                           <b:CostCenterIdentity>
                              <b:CostCenterId i:nil="true"/>
                              <b:CostCenterName>Executive Team (USA)</b:CostCenterName>
                              <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
                              <b:CostCenterUid>1152921504606867363</b:CostCenterUid>
                           </b:CostCenterIdentity>
                           <b:ExpenseReportVendorIdentity i:nil="true"/>
                           <b:InactiveFlag>false</b:InactiveFlag>
                           <b:LocationIdentity>
                              <b:LocationId i:nil="true"/>
                              <b:LocationName>USA</b:LocationName>
                              <b:LocationUid>1152921504606855985</b:LocationUid>
                           </b:LocationIdentity>
                           <b:MissingTimeEmailFlag>true</b:MissingTimeEmailFlag>
                           <b:PayCategory>S</b:PayCategory>
                           <b:RdcException i:nil="true"/>
                           <b:ResourceTypeIdentity>
                              <b:ResourceTypeCode>FTE</b:ResourceTypeCode>
                              <b:ResourceTypeId i:nil="true"/>
                              <b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
                              <b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
                           </b:ResourceTypeIdentity>
                           <b:ScheduledHolidaysFlag>true</b:ScheduledHolidaysFlag>
                           <b:SubcontractorInvoiceVendorIdentity i:nil="true"/>
                           <b:TemporaryWorkerFlag>false</b:TemporaryWorkerFlag>
                           <b:TimeAndCostGlccOverride i:nil="true"/>
                           <b:TitleIdentity>
                              <b:DepartmentIdentity>
                                 <b:DepartmentId i:nil="true"/>
                                 <b:DepartmentName>Executive Team</b:DepartmentName>
                                 <b:DepartmentUid>1152921504606854181</b:DepartmentUid>
                              </b:DepartmentIdentity>
                              <b:TitleId i:nil="true"/>
                              <b:TitleName>Level 1</b:TitleName>
                              <b:TitleUid>1152921504606875471</b:TitleUid>
                           </b:TitleIdentity>
                           <b:TrackMissingTimeFlag>true</b:TrackMissingTimeFlag>
                           <b:WorkingScheduleOverrides/>
                        </b:Record>
                     </b:PwsResourceHistory>
                  </b:History>
                  <b:LastUpdatedByUser>
                     <b:UserDisplayName>IT Manager</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607134366</b:UserUid>
                     <b:EmailAddress>itmanager@revcorp.bb</b:EmailAddress>
                     <b:FirstName>IT</b:FirstName>
                     <b:LastName>Manager</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:LastUpdatedByUser>
                  <b:LastUpdatedTimestamp>2018-10-17T18:57:54.427Z</b:LastUpdatedTimestamp>
                  <b:ResourceDetail>
                     <b:ResourceDisplayName>Web Services</b:ResourceDisplayName>
                     <b:ResourceId i:nil="true"/>
                     <b:ResourceReferenceSystemId>WS01</b:ResourceReferenceSystemId>
                     <b:ResourceUid>1152921504607131538</b:ResourceUid>
                     <b:EmailAddress>webservices@revcorp.bb</b:EmailAddress>
                     <b:FirstName>Web</b:FirstName>
                     <b:LastName>Services</b:LastName>
                     <b:MiddleName i:nil="true"/>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:ExpenseApprovalUserIdentity>
                        <b:UserDisplayName>IT Manager</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607134366</b:UserUid>
                     </b:ExpenseApprovalUserIdentity>
                     <b:ExpenseEntryDelegateUserIdentity i:nil="true"/>
                     <b:Initials>WS</b:Initials>
                     <b:LatestHistoryRecord>
                        <b:ActualHolidaysFlag>true</b:ActualHolidaysFlag>
                        <b:AllowApproveOwnTimecardsFlag>true</b:AllowApproveOwnTimecardsFlag>
                        <b:BillableFlag>true</b:BillableFlag>
                        <b:CostCenterIdentity>
                           <b:CostCenterId i:nil="true"/>
                           <b:CostCenterName>Executive Team (USA)</b:CostCenterName>
                           <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
                           <b:CostCenterUid>1152921504606867363</b:CostCenterUid>
                        </b:CostCenterIdentity>
                        <b:ExpenseReportVendorIdentity i:nil="true"/>
                        <b:InactiveFlag>false</b:InactiveFlag>
                        <b:LocationIdentity>
                           <b:LocationId i:nil="true"/>
                           <b:LocationName>USA</b:LocationName>
                           <b:LocationUid>1152921504606855985</b:LocationUid>
                        </b:LocationIdentity>
                        <b:MissingTimeEmailFlag>true</b:MissingTimeEmailFlag>
                        <b:PayCategory>S</b:PayCategory>
                        <b:RdcException i:nil="true"/>
                        <b:ResourceTypeIdentity>
                           <b:ResourceTypeCode>FTE</b:ResourceTypeCode>
                           <b:ResourceTypeId i:nil="true"/>
                           <b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
                           <b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
                        </b:ResourceTypeIdentity>
                        <b:ScheduledHolidaysFlag>true</b:ScheduledHolidaysFlag>
                        <b:SubcontractorInvoiceVendorIdentity i:nil="true"/>
                        <b:TemporaryWorkerFlag>false</b:TemporaryWorkerFlag>
                        <b:TimeAndCostGlccOverride i:nil="true"/>
                        <b:TitleIdentity>
                           <b:DepartmentIdentity>
                              <b:DepartmentId i:nil="true"/>
                              <b:DepartmentName>Executive Team</b:DepartmentName>
                              <b:DepartmentUid>1152921504606854181</b:DepartmentUid>
                           </b:DepartmentIdentity>
                           <b:TitleId i:nil="true"/>
                           <b:TitleName>Level 1</b:TitleName>
                           <b:TitleUid>1152921504606875471</b:TitleUid>
                        </b:TitleIdentity>
                        <b:TrackMissingTimeFlag>true</b:TrackMissingTimeFlag>
                        <b:WorkingScheduleOverrides/>
                     </b:LatestHistoryRecord>
                     <b:LatestHistoryRecordBeginDate>2018-10-01T00:00:00Z</b:LatestHistoryRecordBeginDate>
                     <b:ManagerUserIdentity>
                        <b:UserDisplayName>IT Manager</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607134366</b:UserUid>
                     </b:ManagerUserIdentity>
                     <b:RequestedTimeOffApprovalUserIdentity>
                        <b:UserDisplayName>IT Manager</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607134366</b:UserUid>
                     </b:RequestedTimeOffApprovalUserIdentity>
                     <b:SkillApprovalUserIdentity>
                        <b:UserDisplayName>IT Manager</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607134366</b:UserUid>
                     </b:SkillApprovalUserIdentity>
                     <b:TimeEntryDelegateUserIdentity i:nil="true"/>
                     <b:TimecardApprovalFlag>true</b:TimecardApprovalFlag>
                     <b:TimecardApprovalUserIdentity>
                        <b:UserDisplayName>IT Manager</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607134366</b:UserUid>
                     </b:TimecardApprovalUserIdentity>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>RS-Text List</b:UdfName>
                           <b:UdfUid>1152921504606856828</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Grade A</b:TextValue>
                           <b:UdfTreatment>R</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                     </b:UserDefinedFields>
                     <b:UserIdentity>
                        <b:UserDisplayName>Web Services</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>WS01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607067736</b:UserUid>
                     </b:UserIdentity>
                     <b:VendorReferenceSystemId>Web Services</b:VendorReferenceSystemId>
                  </b:ResourceDetail>
                  <b:SkillLevels/>
                  <b:SkillsApprovedByUser i:nil="true"/>
                  <b:SkillsApprovedTimestamp i:nil="true"/>
                  <b:SkillsLastUpdatedByUser i:nil="true"/>
                  <b:SkillsLastUpdatedTimestamp i:nil="true"/>
                  <b:SkillsRejectedFlag>false</b:SkillsRejectedFlag>
                  <b:SkillsRejectedReason i:nil="true"/>
                  <b:SkillsRejectedTimestamp i:nil="true"/>
                  <b:Timestamp>AAAAABCI7Hk=</b:Timestamp>
                  <b:VendorIdentity>
                     <b:VendorId i:nil="true"/>
                     <b:VendorName>Web Services</b:VendorName>
                     <b:VendorUid>1152921504607085149</b:VendorUid>
                     <b:VendorNumber>Web Services</b:VendorNumber>
                  </b:VendorIdentity>
               </b:PwsResourceElement>
            </a:Resources>
         </PwsGetResourceResult>
      </PwsGetResourceResponse>
   </s:Body>
</s:Envelope>

PwsGetResource - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

105AtLeastOneItemNotFoundAt least one requested item was not found. The remaining items, if any, were returned.
50070AccessPermissionDeniedPermission denied.
  • No labels