Difference between revisions of "API Method QueueRetrieve"

From Updox API
Jump to: navigation, search
(Responses)
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
A method to obtain a specific item from the Integration Queue.
+
A method to retrieve a specific item from the Integration Queue.  Usually called after obtaining a queued item's messageId by calling [[API Method QueueList|/QueueList]].  All items identified by this method as available for processing will remain on the Integration Queue until a call is made to the [[API Method QueueUpdate|/QueueUpdate]] method.
 
    
 
    
 
== Fields ==
 
== Fields ==
Please refer to the [https://updoxqa.com/iodox/updox-iodox Interactive API] for a list of the fields for this method.
+
Please refer to the [https://updoxqa.com/iodox/updox-iodox Interactive API] for a list of the fields for this method.
 
+
  
 
== Sample Request and Response ==
 
== Sample Request and Response ==
Line 21: Line 20:
  
 
[[Integration Queue Processing - Faxes]]
 
[[Integration Queue Processing - Faxes]]
 +
 
[[Integration Queue Processing - CCD]]
 
[[Integration Queue Processing - CCD]]

Latest revision as of 13:57, 10 August 2015

A method to retrieve a specific item from the Integration Queue. Usually called after obtaining a queued item's messageId by calling /QueueList. All items identified by this method as available for processing will remain on the Integration Queue until a call is made to the /QueueUpdate method.

Contents

Fields

Please refer to the Interactive API for a list of the fields for this method.

Sample Request and Response

Request

 {
 "auth":{
   "applicationId":"updox",
   "applicationPassword":"password",
   "accountId":"100"
   },
 "messageId":"474030c0-a57e-4386-a377-c1eebfa7a084"
 }

Responses

Integration Queue Processing - Faxes

Integration Queue Processing - CCD