StatusCode and RecStatus

Hi,

Is there a document somewhere that records all status codes and status messages? I want to see what kind of error it could have when I submit a request (such as jobSubmitRequest). I am programming my application to handle ALL those errors properly. I only know one of the status code is 2209 for "User Authentication not accepted".

Also the same goes for RecStatus. In some cases, statusCode is 0 (meaning the request was processable), but RecStatus is 2052 for "Job not owned by user". It would be helpful if you have a document for RecStatus codes and messages as well.

Thank you in advance.

Quan

Find more posts tagged with

Comments

tgargiulo

Hi Quan.

Please refer to the following link within the forum to assist you with status codes and messages: https://apiforums.easylink.com/content/gamma-codes.

quan.tran1

Hi,
Thanks for the reply. I tried to match some status codes I provide earlier with the gamma code table, but none of them matches. I think those are two different type of code.

For now, I want to know the format of return XML message when EasyLink service is not available.

Thank you.

tgargiulo

The response
you are getting from the JobSubmit will not contain gamma codes. The response
only pertains to the JobSubmit itself, such as whether or not your credentials
are valid, system problem, etc. A StatusCode of "0" and StatusMessage
of "OK" within the Status tag, along with an XDN and MDN within the
JobId tag confirms the job was accepted.

Please refer
to the following link to obtain the error/gamma status codes and messages for the job delivery:

https://apiforums.easylink.com/content/poll-job-delivery-status-get-latest-state

quan.tran1

Hi,

Thanks for all the help so far. There was a part in my question that got unanswered. Now it's getting back to haunt me...

Let's say if I call JobSubmit but EasyLink service is down. Is there going to be an XML response back to me saying that the service is down? If yes, I'd love to see the structure of that XML.

tgargiulo

If our
web/app servers are actually not available, you would not be able to connect
to us so you wouldn't receive an XML response.

If our web/app servers are actually not available, they
would not be able to connect to us. Different application tools may indicate
such problems in different ways - a SOAP Fault, an exception, an error
indication, and so on. And the presence of intermediate proxies and firewalls
can affect the exact behavior too. So we can't know exactly how this shows up
for a particular user. But this is the rarest of cases may never
have happened.

If the switch to which a request would normally be sent
has been given an internal "down" state, then an error result might
be returned. The details of this - like the error code - may vary from one
function to another, and some may even return a SOAP Fault. But as an example, JobDeliveryStatus, it would
in this case return something like this:

<StatusMessage>[not]Domain not available for this request
</StatusMessage>

</Status>

</JobDeliveryStatusResult>

If the webservice is temporarily unavailable due to
congestion, a SOAP Fault is returned (with HTTP code 500), and a reply body
that looks like this

<?xml version="1.0"
encoding="UTF-8"?>

<Body>

<soapenv:Fault
xmlns="">

<faultcode>soapenv:Server</faultcode>

<faultstring>Processing for JobSubmitRequest requests is
temporarily unavailable due to service congestion</faultstring>

<detaildata>JobSubmitRequest cannot be sent to queue
queue/PC.jobSubmit</detaildata>

</detail>

</soapenv:Fault>

</Body>

</Envelope>

For functions, like JobList or QueuedDocumentRetrieve,
that contact multiple switches, a "partial" result is possible if one
or more of the domains is unavailable. This is indicated by a "2"
StatusCode value like this:

<StatusMessage>Partial</StatusMessage>

If a request is accepted, but there is a problem
contacting a necessary internal service, then an error result (non-zero
StatusCode with associated error or message information) is generally returned.
The detail codes and messages will vary among the functions and may depend on
which service was a problem, but for an example, if the job status server could
not, for some reason, be contacted, the JobDeliveryStatusResult would contain
something like:

<StatusMessage>Error calling Job DeliveryStatus service Connection refused</StatusMessage>

quan.tran1

Thanks for the detailed answer. I got it now.