...
This web service retrieves a list of vendor summary records (PwsEngagementSummaryPwsVendorSummary), 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 number.
- IncludeInactiveFlag. If true, inactive vendors will be returned. Otherwise, only vendors that are not considered inactive will be returned.
- VendorId/VendorName/VendorUid/VendorNumberVendorIdentity. If specified, the identified vendor will be returned (QueryString and IncludeClosedFlag will be ignored).
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
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 supplieris linked to a Projector resource, and is the vendor used when reimbursing the resource directly for expenses. Every Projector resource has a linked vendor for this purpose. 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 | |
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 | 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. |
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-05T18:56:29.1103449Z |
Vendors | The vendor summary records that were fetched by the service. |
Response Usage Example(s)
...