LSErrorDetail

Error Detail for integration with Letterstream api

Average rating: 5.0 (1 vote) Log in to vote

Robert D Trammel - Show more from this author
https://www.linkedin.com/in/robertdtrammel/

Sample input:

LSErrorDetail( -1 )
LSErrorDetail( -200 )

Sample output:

"Needs Attention"
"Successful preauth: Please resubmit authcode to complete order"

Function definition: (Copy & paste into FileMaker's Edit Custom Function window)

//Mapping Letterstream Error Codes for Troubleshooting - RT | 10/17/2023
// code.name, code.description
// Example input LSErrorDetail( -1 ) retuns "Needs Attention"

Let([
   errors = JSONSetElement( "";
      //Non-Error System Messages
      [ "1.name"; "Status"; 1];[ "1.description"; "Mailed - Job Complete"; 1 ];
      [ "0.name"; "Status"; 1];[ "0.description"; "In Production"; 1 ];
      [ "-1.name"; "Status"; 1];[ "-1.description"; "Needs Attention"; 1 ];
      [ "-2.name"; "Status"; 1];[ "-2.description"; "Job Deleted"; 1 ];
      [ "-100.name"; "Order Initiated"; 1];["-100.description"; "Success: Order Initiated"; 1];
      [ "-101.name"; "Pending Funding"; 1];["-101.description"; "Account does not have sufficient funding available to process letters. Please add funds."; 1];
      [ "-103.name"; "Payment Applied"; 1];["-103.description"; "Funding received and applied"; 1];
      [ "-104.name"; "In Production"; 1];["-104.description"; "Item is currently being processed and will be transferred to the postal service once complete"; 1];
      ["-105.name"; "Order Initiated in Test Mode"; 1];["-105.description"; "Item has been submitted in test mode and will only proceed in to production by logging in to the LetterStream website and proceeding to the shopping cart."; 1 ];
      ["-110.name"; "Added Recipients"; 1];["-110.description"; "Successfully added recipients to job"; 1];
      ["-120.name"; "Received Counts"; 1];["-120.description"; "Received"; 1];
      ["-150.name"; "Mailed"; 1 ];["-150.description"; "Item has been delivered to the US Postal Service."; 1];
      ["-199.name"; "Auth OK"; 1];["-199.description"; "AUTHOK"; 1];
      ["-200.name"; "PreAuth"; 1];["-200.description"; "Successful preauth: Please resubmit authcode to complete order"; 1 ];
      ["-208.name"; "Info"; 1];["-208.description"; "Info:"; 1];
      ["-330.name"; "Signature"; 1];["-330.description"; "Certified signature is not yet available"; 1];
      ["-331.name"; "Not Certified"; 1];["-331.description"; "Notice: Item is not certified therefor signature files do not exist"; 1];
      ["-332.name"; "Job Status"; 1];["-332.description"; "Notice: No history exists"; 1 ];

      //Warnings (non-fatal)
      ["-300.name"; "Recipient"; 1];["-300.description"; "Recipient address could not be validated"; 1];
      ["-330.name"; "Signature"; 1];["-330.description"; "Certified signature is not yet available"; 1 ];
      ["-331.name"; "Not Certified"; 1];["-331.description"; "Notice: Item is not certified therefor signature files do not exist"; 1];
      ["-332.name";"Job Status"; 1];["-332.description";  "Notice: No history exists"; 1];
      ["-555.name"; "Notice"; 1];["-555.description"; "Notice:"; 1 ];

      //Errors (fatal)
      ["-900.name"; "Job Name"; 1];["-900.description"; "Failed: Job name must be 8 to 20 characters (a-zA-Z0-9_-)"; 1];
      ["-901.name"; "Recipient"; 1];["-901.description"; "Failed: Missing recipient address"; 1];
      ["-902.name"; "Sender"; 1];["-902.description"; "Failed: Missing sender address"; 1];
      ["-903.name"; "Page Count"; 1];["-903.description"; "Failed: Page count out of range"; 1];
      ["-904.name"; "Page Count"; 1];["-904.description"; "Failed: Document page count does not match received page count"; 1];
      ["-905.name"; "Sheet Color"; 1];["-905.description"; "Failed: Provided sheet color is invalid"; 1];
      ["-906.name"; "Mail Type"; 1];["-906.description"; "Failed: Provided MailType is invalid"; 1];
      ["-907.name"; "Paper Type"; 1];["-907.description"; "Failed: Provided PaperType is invalid"; 1];
      ["-908.name"; "Duplex Err"; 1];["-908.description"; "Failed: 1 page documents must not be flagged as duplex"; 1];
      ["-909.name"; "CertifiedIntl"; 1];["-909.description"; "Failed:"; 1 ];
      ["-910.name"; "Missing File"; 1];["-910.description"; "Failed: Missing Document File"; 1 ];
      ["-911.name"; "Funding"; 1];["-911.description"; "Warning: Insufficient funding. Items will not be processed until additional funding is added to your account"; 1];
      ["-912.name"; "File Type"; 1];["-912.description"; "Failed: Wrong file type"; 1];
      ["-913.name"; "Archive Error"; 1];["-913.description"; "Failed: No files found in submitted archive"; 1];
      ["-914.name"; "File Transfer"; 1];	["-914.descripition"; "Failed: Could not copy file"; 1];
      ["-915.name"; "File Error"; 1];["-915.description"; "Failed: File error"; 1];
      ["-916.name"; "File Error"; 1];["-916.description"; "Failed: Could not open PDF for reading"; 1];
      ["-917.name"; "File Error"; 1];["-917.description";  "Failed: PDF file count does not match data file PDFs"; 1];
      ["-918.name"; "File Link Error"; 1];["-918.description"; "Failed: File Link Error"; 1];
      ["-920.name"; "API ID"; 1];["-920.description"; "Failed: Missing API Id"; 1];
      ["-921.name"; "Doc ID"; 1];["-921.description"; "Failed: Doc Id must be 6 to 30 alphanumeric"; 1];
      ["-922.name"; "Doc ID"; 1];["-922.description"; "Failed: Document Id error"; 1];
      ["-924.name"; "Doc ID"; 1];["-924.description"; "Failed: invalid doc id"; 1];
      ["-925.name"; "Batch ID"; 1];["-925.description"; "Failed: Batch Id is not unique"; 1];
      ["-926.name"; "batchstatus"; 1];["-926.description"; "Failed: invalid batch id"; 1];
      ["-928.name"; "jobstatus"; 1];["-928.description"; "Failed: invalid job id"; 1];
      ["-929.name"; "tracking"; 1];["-929.description"; "Failed: invalid tracking id"; 1];
      ["-930.name"; "Unknown"; 1];["-930.description"; "Failed: Unable to parse data"; 1];
      ["-935.name"; "Extra Insert"; 1];["-935.description"; "Failed: Unable to handle saved insert"; 1];
      ["-940.name"; "CertifiedPageCount"; 1];["-940.description"; "Failed:"; 1 ];
      ["-950.name"; "Auth Err"; 1];["-950.description"; "Authentication Failed:"; 1];
      ["-951.name"; "Cobrand"; 1];["-951.description"; "Cobrand Err"; 1];
      ["-952.name"; "Auth Err"; 1];["-952.description"; "Authentication Failed: Missing API_ID"; 1];
      ["-953.name"; "Auth Err"; 1];["-953.description";	 "Authentication Failed: Missing Hash"; 1];
      ["-954.name"; "Auth Err"; 1];["-954.description"; "Authentication Failed: t arg does not meet requirements"; 1];
      ["-955.name"; "Auth Err"; 1];["-955.description"; "Authentication Failed: Missing unique_id (t arg)"; 1];
      ["-956.name"; "Auth Err"; 1];["-956.description"; "Authentication Failed: c arg does not meet requirements"; 1];
      ["-957.name"; "Auth Err"; 1];["-957.description"; "Authentication Failed: DUP"; 1];
      ["-958.name"; "Auth Err"; 1];["-958.description"; "Authentication Failed: IDOK"; 1];
      ["-959.name"; "Auth Err"; 1];["-959.description"; "Authentication Failed: BAD"; 1];
      ["-960.name"; "doauth"; 1];["-960.description"; "Failed: doauth"; 1];
      ["-970.name"; "Job Info"; 1];["-970.description"; "Certified tracking number invalid"; 1];
      ["-980.name"; "Maintenance"; 1];["-980.description"; "We are currently down for maintenance. Returning soon."; 1];
      ["-997.name"; "Error"; 1];["-997.description"; "Rate Limit:"; 1 ];
      ["-998.name"; "Error"; 1];["-998.description"; "Improper submission format:"; 1];
      ["-999.name"; "Error"; 1];["-999.description"; "Error:"; 1]
    )
];
    JSONGetElement( errors; errorCode & ".description" )
)

This may be a very niche corner of the market, but I have a customer who utilizes Letterstream to send a lot of physical mail. Their API is available only to customers, and as such the documentation can be difficult to navigate at times. I wrote this custom function in order to return more actionable error detail from failed api calls. Their original HTML table of codes consisted of three columns, Code, Name, and Description. I wrote a little while loop to build this JSON structure for quicker reference.

Comments

Note: these functions are not guaranteed or supported by BrianDunning.com. Please contact the individual developer with any questions or problems.

LSErrorDetail

Comments

Support this website.

Support this website.