PwsGetVendor

Overview


This web service retrieves a list of vendor element records (PwsVendorElement), based upon a list of unique vendor identifiers (PwsVendorRef).

Request Format


PwsGetVendor 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.

AV795EkfoxzwEpVD7pZJJA== 

VendorIdentities

PwsVendorRef[]

Yes 

The unique fields identifying the vendor(s) 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:PwsGetVendor>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AV795EkfoxzwEpVD7pZJJA==</req:SessionTicket>
            <req:VendorIdentities>
               <com:PwsVendorRef>
                  <com:VendorName>American Express</com:VendorName>
                  <com:VendorUid>1152921504606937722</com:VendorUid>
                  <com:VendorNumber>AMEX001</com:VendorNumber>
               </com:PwsVendorRef>
               <com:PwsVendorRef>
                  <com:VendorName>Visa USA</com:VendorName>
                  <com:VendorUid>1152921504606942269</com:VendorUid>
                  <com:VendorNumber>Visa USA</com:VendorNumber>
               </com:PwsVendorRef>
            </req:VendorIdentities>
         </pws:serviceRequest>
      </pws:PwsGetVendor>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetVendor 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


Vendors

PwsVendorElement[]

This structure contains the complete set of information about a vendor.


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetVendorResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetVendorResult 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-05T15:18:46.5132695Z</ServerTimestampUtc>
            <a:Vendors xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsVendorElement>
                  <b:LastUpdatedByUser>
                     <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011057</b:UserUid>
                  </b:LastUpdatedByUser>
                  <b:LastUpdatedTimestamp>2013-08-08T15:13:50.347Z</b:LastUpdatedTimestamp>
                  <b:ResourceIdentity i:nil="true"/>
                  <b:VendorDetail>
                     <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:AnyResourceFlag i:nil="true"/>
                     <b:CostCenterIdentity>
                        <b:CostCenterId i:nil="true"/>
                        <b:CostCenterName>USA</b:CostCenterName>
                        <b:CostCenterNumber>USA</b:CostCenterNumber>
                        <b:CostCenterUid>1152921504606867361</b:CostCenterUid>
                     </b:CostCenterIdentity>
                     <b:NewVendorName i:nil="true"/>
                     <b:NewVendorNumber i:nil="true"/>
                     <b:ResourceVendorPayeeIdentities/>
                     <b:Timestamp>AAAAAARdgxM=</b:Timestamp>
                     <b:VendorReconciliationGlAcct>Vendor Reconcile</b:VendorReconciliationGlAcct>
                  </b:VendorDetail>
               </b:PwsVendorElement>
               <b:PwsVendorElement>
                  <b:LastUpdatedByUser>
                     <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011057</b:UserUid>
                  </b:LastUpdatedByUser>
                  <b:LastUpdatedTimestamp>2017-12-14T21:37:09.797Z</b:LastUpdatedTimestamp>
                  <b:ResourceIdentity i:nil="true"/>
                  <b:VendorDetail>
                     <b:VendorId i:nil="true"/>
                     <b:VendorName>Visa USA</b:VendorName>
                     <b:VendorUid>1152921504606942269</b:VendorUid>
                     <b:VendorNumber>Visa USA</b:VendorNumber>
                     <b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:ResourceVendorFlag>false</b:ResourceVendorFlag>
                     <b:VendorInvoicePayeeFlag>true</b:VendorInvoicePayeeFlag>
                     <b:SubcontractorInvoicePayeeFlag>false</b:SubcontractorInvoicePayeeFlag>
                     <b:AnyResourceFlag>false</b:AnyResourceFlag>
                     <b:CostCenterIdentity>
                        <b:CostCenterId i:nil="true"/>
                        <b:CostCenterName>USA</b:CostCenterName>
                        <b:CostCenterNumber>USA</b:CostCenterNumber>
                        <b:CostCenterUid>1152921504606867361</b:CostCenterUid>
                     </b:CostCenterIdentity>
                     <b:NewVendorName i:nil="true"/>
                     <b:NewVendorNumber i:nil="true"/>
                     <b:ResourceVendorPayeeIdentities>
                        <b:PwsResourceRef>
                           <b:ResourceDisplayName>Mark Wilson</b:ResourceDisplayName>
                           <b:ResourceId i:nil="true"/>
                           <b:ResourceReferenceSystemId>IT (USA) - 02</b:ResourceReferenceSystemId>
                           <b:ResourceUid>1152921504607057127</b:ResourceUid>
                        </b:PwsResourceRef>
                        <b:PwsResourceRef>
                           <b:ResourceDisplayName>Lawrence Jones</b:ResourceDisplayName>
                           <b:ResourceId i:nil="true"/>
                           <b:ResourceReferenceSystemId>IT (USA) - 11</b:ResourceReferenceSystemId>
                           <b:ResourceUid>1152921504607076390</b:ResourceUid>
                        </b:PwsResourceRef>
                     </b:ResourceVendorPayeeIdentities>
                     <b:Timestamp>AAAAAA61L1A=</b:Timestamp>
                     <b:VendorReconciliationGlAcct>Visa USA</b:VendorReconciliationGlAcct>
                  </b:VendorDetail>
               </b:PwsVendorElement>
            </a:Vendors>
         </PwsGetVendorResult>
      </PwsGetVendorResponse>
   </s:Body>
</s:Envelope>

PwsGetVendor - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

59916VendorRefInvalidVendorRef is required.
59918VendorNotFoundVendor not found. Another user may have deleted it.
59919VendorNumberNotUniqueVendor number is not unique.