Overview

This web service retrieves a list of vendor summary records (PwsEngagementSummary), based on specified search criteria. The following parameters affect the list of vendors retrieved:

QueryString. Find all vendors matching specified string in vendor name or vendor number
IncludeInactiveFlag. If true, inactive vendors will be returned. Otherwise, only vendors that are not considered inactive will be returned.
VendorId/VendorName/VendorUid/VendorNumber. If specified, the identified vendor will be returned (QueryString and IncludeClosedFlag will be ignored)

Request Format

PwsGetVendorListRq

PwsGetVendorListRq
- RequestId: Int32
- SessionTicket: String
- IncludeInactiveFlag: Boolean
- IncludeResourceVendorsFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String (255)
- VendorIdentity: PwsVendorRef

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AV795EkfoxzwEpVD7pZJJA==
IncludeInactiveFlag	Boolean	No	false	If set to 'true', inactive vendors will be included in the response. This flag is disregarded if a vendor is specified in VendorIdentity.	true
IncludeResourceVendorsFlag	Boolean	No	false	If set to 'true', resource vendors will be included in the response. A resource vendor is someone who paid an expense out of their own pocket. In essence they are a virtual vendor that needs to be reimbursed just like any subcontractor vendor or supplier. This flag is disregarded if a vendor is specified in VendorIdentity.	true
MaxRowsToReturn	Int32	No		The maximum number of vendors to be returned. This value is disregarded if a vendor is specified in VendorIdentity.	10
QueryString	String (255)	No		A search string to narrow down the results. A vendor will be included in the results if the search string matches the VendorName or VendorNumber. This value is disregarded if a vendor is specified in EngagementTypeIdentity.
VendorIdentity	PwsVendorRef	Yes		For this service, the caller may specify a vendor identity to retrieve a specific vendor summary. If a vendor identity is not specified all vendors fitting the other specified criteria will be returned.

Request Usage Example(s)

Example 01 - Vendor is not specified

<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:PwsGetVendorList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AV795EkfoxzwEpVD7pZJJA==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:IncludeResourceVendorsFlag>true</req:IncludeResourceVendorsFlag>
            <req:MaxRowsToReturn>10</req:MaxRowsToReturn>
         </pws:serviceRequest>
      </pws:PwsGetVendorList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - Vendor is specified

<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:PwsGetVendorList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AV795EkfoxzwEpVD7pZJJA==</req:SessionTicket>
            <req:VendorIdentity>
               <com:VendorName>American Express</com:VendorName>
            </req:VendorIdentity>
         </pws:serviceRequest>
      </pws:PwsGetVendorList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetVendorListRs

PwsGetVendorListRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Vendors: PwsVendorSummary [???]

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-05T18:56:29.1103449Z
Vendors	PwsVendorSummary [???]	The vendor summary records that were fetched by the service

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetVendorListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetVendorListResult 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-03-05T18:56:29.1103449Z</ServerTimestampUtc>
            <a:Vendors xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsVendorSummary>
                  <b:VendorId i:nil="true"/>
                  <b:VendorName>American Express</b:VendorName>
                  <b:VendorUid>1152921504606937722</b:VendorUid>
                  <b:VendorNumber>AMEX001</b:VendorNumber>
                  <b:ExpenseReportPayeeFlag>false</b:ExpenseReportPayeeFlag>
                  <b:InactiveFlag>true</b:InactiveFlag>
                  <b:ResourceVendorFlag>false</b:ResourceVendorFlag>
                  <b:VendorInvoicePayeeFlag>false</b:VendorInvoicePayeeFlag>
                  <b:SubcontractorInvoicePayeeFlag>false</b:SubcontractorInvoicePayeeFlag>
               </b:PwsVendorSummary>
            </a:Vendors>
         </PwsGetVendorListResult>
      </PwsGetVendorListResponse>
   </s:Body>
</s:Envelope>

PwsGetVendorList - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
59918	VendorNotFound	Vendor not found. Another user may have deleted it.