NVMS Web Services [NVMS-PROD1]
Using Our Services...
Our new web service version has been upgraded to use SOAP standards along with WSDL service descriptions.
We now offer many different ways to gather and submit your data. Our services offer a way to retrieve your
data in DataSets or in regular XML strings. You may query orders from your system and then retrieve one service
line at a time. We also offer Binary serialized data (for big DataSets) that greatly reduces large respones.
Your company must be setup and given access to use our services...
If you are interested in utilizing our web services, please contact webservices@nvms.com, or
call (703) 361-6262 and talk to someone in our Client Service Department.
Technical Help Documents
Class Documentation | PDF Help Document
Testing Our Services...
We offer a testing bed for every service we provide so you can work with our web services before you go live. When you
test our services you WILL need an NVMSKey. Please contact us to get a testing key. However, when you go
live this key will stay the same, you will just have to point your request to our live service. This key resides in the SoapHeader of your request. Please
take a look at the service description for an example SOAP request.
View our demo services.
If you'd like to test the requests without a key, you can use this service:
View our quick test services.
Details For Each Service >>>
- ClientServiceDataSet :: Invoke this service with no Parameters - A DataSet of all serivces is returned.
- ClientServiceString :: Invoke this service with no Parameters - An XML document of all serivces is returned.
- ClientUsersDataSet :: Invoke this service with no Parameters - A DataSet of all active users is returned.
- ClientUsersString :: Invoke this service with no Parameters - An XML document of all active users is returned.
- LineItemOrderStatus :: Invoke this service with either your FileNumber or our NVMSJobID as Parameters - A DataSet of your query is returned. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 for Parameters.)
- QueryOrderDelivery :: (Returns Final Reports w/Images) Invoke this service with Parameter: TimeFrame to receive a list of orders delivered within the given time frame. (no testing currently available for this method - Let us know if you want to test and we'll set it up for you.)
- GetClientJobNotes :: (Returns Client Notes for given job) Invoke this service with Parameter: NVMSJobID, or your FileNumber - This returns a XML String. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 for Parameters.)
- QueryImages :: (Returns Images Only) Invoke this service with Parameters: LineItemID, NVMSJobID, or your FileNumber to receive images/attachments for given parameter. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 or LineItemID(s): 88763 or 54590 for Parameters.)
- QueryOrder :: (Returns Final Reports w/Images) Invoke this service with Parameters: LineItemID, NVMSJobID, or your FileNumber to receive complete order and images/attachements for given parameter. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 or LineItemID(s): 88763 or 54590 for Parameters.)
- QueryReport :: (Returns Final Report Only) Invoke this service with Parameters: LineItemID, NVMSJobID, or your FileNumber to receive complete order and images/attachements for given parameter. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 or LineItemID(s): 88763 or 54590 for Parameters.)
- QueryReportImagesByLineItem :: (Still Testing) Invoke this service with Parameters: LineItemID or NVMSJobID to receive complete order and images/attachements for given parameter IN BINARY DataSet. (For Testing purposes, you can use either JobID: 40005 or LineItemID(s): 88763 or 54590 for Parameters.)
- QueryCollectionData :: (Returns Custom Collection Data in XML String Format) Invoke this service with Parameters: LineItemID, NVMSJobID, PONumber or your FileNumber to receive customized collection data for your client/template specific form. This must be customized by NVMS before any data will be returned.
- QueryCollectionDataImages :: (Returns Custom Collection Data in XML String Format and Images in Base64) Invoke this service with Parameters: LineItemID, NVMSJobID, PONumber or your FileNumber to receive customized collection data for your client/template specific form. This must be customized by NVMS before any data will be returned.
- FullNVMSDataService :: (Returns Custom Collection Data in XML String Format, Images and PDF of final report in Base64) Invoke this service with Parameter: NVMSJobID to receive customized collection data for your client/template specific form. This must be customized by NVMS before any data will be returned.
- RetrieveOrderPDF :: (Returns Final Reports in Bas64 PDF Format) This returns report in PDF (Base64) format for passed NVMSJobID only... All images and report for complete order in one PDF file. >> In XML format
- SingleOrderStatus :: Invoke this service with Parameters: NVMSJobID or your FileNumber to receive order status for given parameter. (For Testing purposes, you can use either FileNumber: 123456 or JobID: 40005 for Parameters.)
- CancelOrderRequest :: Invoke this service with Parameters: NVMSJobID and CancelNote to request the cancellation of an order. (Testing: 40005 for Parameters.)
- TestMyCredentials :: For testing purposes only... You will receive an error when invoking this method. It's here just to show you how the SOAP header should be passed in your live services.
- ShippingAddressListDataSet :: Invoke this service with Parameters: NVMSJobID, FileNumber or ByDate to retrieve dataset of shipping addresses for passed parameters (Testing: 40005 for Parameters.)
- ShippingAddressListStr :: Invoke this service with Parameters: NVMSJobID, FileNumber or ByDate to retrieve XML String of shipping addresses for passed parameters. (Testing: 40005 for Parameters.)
Going Live...
Below is the link to the live services with descriptions for each. See the document below for help with submitting requests to
our services. We are always trying to improve our systems, so if you have any comments or requests please contact us at the above email address.
If you need support right away, please call (703) 361-6262 x104 for immediate assistance.
View our live/production services.