Skip to content

Client reference

This page documents every operation of SimpleCertifiedMail ADS API† that the generated ADSAPISoapClient exposes: the one operation repository source calls through the authored wrapper SimpleCertifiedMailServiceProxy, and the seven remaining declared operations, which have no call site anywhere in this repository. Because Reference.svcmap sets GenerateInternalTypes=false, the generated client is public, so a downstream package consumer could invoke any of the seven uncalled operations directly*.


getCertifiedLabel

Requests a certified-mail shipping label image from the third-party service for a given sender/recipient pair, using account credentials supplied at the call site or falling back to environment settings.

Field Value
Operation getCertifiedLabel
SOAP action https://simplecertifiedmail.com/getCertifiedLabel
Proxy member LabelReturn getCertifiedLabel(CertifiedLabelRequest clr) (generated, public)
Input message CertifiedLabelRequest
Output message LabelReturn
Declared faults None declared
Called by SimpleCertifiedMailServiceProxy.GetCertifiedLabel(CertifiedLabelData) (private) (Services/SAIF.Services.Web.Proxies/SimpleCertifiedMailServiceProxy.cs:92-140)
Source SimpleCertifiedMailServiceProxy.cs:131

Input message

Part Type Required Bound from Purpose
PartnerKey, UserName, Password, ClientCode string Not stated in the WSDL Caller-supplied CertifiedLabelData, falling back to environment settings Account credentials
GroupName string Not stated in the WSDL Caller-supplied, defaulting to constant "ADMINISTRATION" Account group
FromAddress1/2, ToName string Not stated in the WSDL Caller-supplied, truncated to 46 characters Sender/recipient address lines
Mode ModeOptions Not stated in the WSDL CertifiedLabelData.IsProductionMode if set, otherwise IEnvironmentService.IsProduction Preview vs. production
DateAdvance, UseSL250, SortType int / boolean / SortTypeOptions Not stated in the WSDL Fixed values: 0, false, None Constants, not configurable per call
Remaining RequestBase/CertifiedLabelRequest fields various Not stated in the WSDL Mapped from CertifiedLabelData Sender/recipient identity and label formatting

Output message

The wrapper reads StatusCode to decide success and, on success, returns LabelImage; PIC and LabelCost are read from the response but discarded.

Part Type Consumed by the caller Notes
StatusCode int Yes Compared against 1 to determine success
StatusMessage string Yes Embedded in the thrown SimpleCertifiedException message on failure
LabelImage string (base64) Yes Returned to GetCertifiedLabel's caller as the label image
PIC string No Discarded
LabelCost decimal No Discarded

Faults

Fault Surfaces as Handled at the call site
In-band failure (StatusCode != 1) SimpleCertifiedException Handled — logged via ILogService.LogException and thrown (SimpleCertifiedMailServiceProxy.cs:133-137)
Generic SOAP fault FaultException* Not handled — no try/catch surrounds the call; propagates raw
Transport failure CommunicationException* Not handled — propagates raw
Timeout TimeoutException* Not handled — propagates raw

Call site

var result = _webService.getCertifiedLabel(request);
if (result.StatusCode != 1)
{
    var ex = new SimpleCertifiedException("SimpleCertifiedMailServiceProxy Error: " + result.StatusMessage);
    _logService.LogException("SimpleCertifiedMailService", "GetCertifiedLabel", "", ex);
    throw ex;
}
return result.LabelImage;
Aspect Finding
Invocation frequency Per subpoena recipient / per opposing-counsel label
Result cached No
Timeout at this call site None — binding defaults apply
Retry at this call site None

Notes

  • Reached through two public wrapper methods: SaveLabelAsGif (renders the returned image to a .gif file) and GetLabelOnly (returns the label without saving it; this path has no callers in the repository).
  • FromAddress1/2 and ToName are silently truncated to 46 characters with no warning to the caller — see Business rules.

queuePrintItem

Queues a print item (a document plus optional certified-mail request) for production by the third-party service. No repository source calls this operation.

Field Value
Operation queuePrintItem
SOAP action https://simplecertifiedmail.com/queuePrintItem
Proxy member PrintReturn queuePrintItem(PrintRequest qpr) (generated, public)
Input message PrintRequest
Output message PrintReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
DocTypeName, TemplateName string Not stated in the WSDL Not applicable — no call site Document type and template selection
RequestCertified, UseSL250 boolean Not stated in the WSDL Not applicable — no call site Certified-mail and SL250 flags
Document base64Binary Not stated in the WSDL Not applicable — no call site The document to print
PageCount int Not stated in the WSDL Not applicable — no call site Enclosure page count
Remaining RequestBase fields various Not stated in the WSDL Not applicable — no call site Account credentials and sender/recipient identity, as in getCertifiedLabel

Output message

Part Type Consumed by the caller Notes
StatusCode, StatusMessage int / string Not applicable — no call site In-band success/failure signal, as in ReturnBase
QueueID int Not applicable — no call site The queued print item's identifier

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

getDocumentStatus

Retrieves the status of one or more previously submitted documents within a date range. No repository source calls this operation.

Field Value
Operation getDocumentStatus
SOAP action https://simplecertifiedmail.com/getDocumentStatus
Proxy member ArrayOfDocumentStatusReturn getDocumentStatus(DocumentStatusRequest doc) (generated, public)
Input message DocumentStatusRequest
Output message ArrayOfDocumentStatusReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
PartnerKey, UserName, Password, ClientCode string Not stated in the WSDL Not applicable — no call site Account credentials
PIC, ReferenceNumber, ItemID string Not stated in the WSDL Not applicable — no call site Alternative document lookup keys
StartDate, EndDate dateTime Not stated in the WSDL Not applicable — no call site Date range for the status query

Output message

Part Type Consumed by the caller Notes
DocumentStatusReturn[] (ArrayOfDocumentStatusReturn) array of complex type Not applicable — no call site One entry per matching document, carrying status, delivery, and signature detail

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

getDocumentStatusByRef

Retrieves document status by the caller-supplied ReferenceNumber rather than a date range. No repository source calls this operation.

Field Value
Operation getDocumentStatusByRef
SOAP action https://simplecertifiedmail.com/getDocumentStatusByRef
Proxy member ArrayOfDocumentStatusReturn getDocumentStatusByRef(DocumentStatusRequest doc) (generated, public)
Input message DocumentStatusRequest
Output message ArrayOfDocumentStatusReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
DocumentStatusRequest fields various Not stated in the WSDL Not applicable — no call site Same shape as getDocumentStatus; the operation name, not the message shape, selects lookup-by-reference behavior at the service

Output message

Part Type Consumed by the caller Notes
DocumentStatusReturn[] (ArrayOfDocumentStatusReturn) array of complex type Not applicable — no call site Same shape as getDocumentStatus

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

getDocumentStatusByItemID

Retrieves document status by the caller-supplied ItemID rather than a date range. No repository source calls this operation.

Field Value
Operation getDocumentStatusByItemID
SOAP action https://simplecertifiedmail.com/getDocumentStatusByItemID
Proxy member ArrayOfDocumentStatusReturn getDocumentStatusByItemID(DocumentStatusRequest doc) (generated, public)
Input message DocumentStatusRequest
Output message ArrayOfDocumentStatusReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
DocumentStatusRequest fields various Not stated in the WSDL Not applicable — no call site Same shape as getDocumentStatus; lookup is by ItemID

Output message

Part Type Consumed by the caller Notes
DocumentStatusReturn[] (ArrayOfDocumentStatusReturn) array of complex type Not applicable — no call site Same shape as getDocumentStatus

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

getProductionReport

Retrieves a production report over a date range or as a daily recap. No repository source calls this operation.

Field Value
Operation getProductionReport
SOAP action https://simplecertifiedmail.com/getProductionReport
Proxy member ProductionReportReturn getProductionReport(ProductionReportRequest rpt) (generated, public)
Input message ProductionReportRequest
Output message ProductionReportReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
PartnerKey, UserName, Password, ClientCode string Not stated in the WSDL Not applicable — no call site Account credentials
ReportMode ProductionReportMode (daterange | dailyrecap) Yes Not applicable — no call site Selects the report shape
StartDate, EndDate dateTime Yes Not applicable — no call site Report date range

Output message

Part Type Consumed by the caller Notes
StatusCode, StatusMessage int / string Not applicable — no call site In-band success/failure signal
ProductionReport string Not applicable — no call site The report content

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

verifyUserCredentials

Verifies a set of account credentials against the third-party service without performing any mail or print action. No repository source calls this operation.

Field Value
Operation verifyUserCredentials
SOAP action https://simplecertifiedmail.com/verifyUserCredentials
Proxy member VerifyReturn verifyUserCredentials(string PartnerKey, string UserName, string Password, string ClientCode, string GroupName) (generated, public)
Input message PartnerKey, UserName, Password, ClientCode, GroupName (bare parts, not wrapped in a request type)
Output message VerifyReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
PartnerKey, UserName, Password, ClientCode, GroupName string Not stated in the WSDL Not applicable — no call site Account credentials to verify

Output message

Part Type Consumed by the caller Notes
StatusCode, StatusMessage int / string Not applicable — no call site In-band success/failure signal
IsValid boolean Not applicable — no call site Whether the supplied credentials are valid

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

getPrintStatusUpdate

Retrieves the print status of previously queued print items for the given account. No repository source calls this operation.

Field Value
Operation getPrintStatusUpdate
SOAP action https://simplecertifiedmail.com/getPrintStatusUpdate
Proxy member PrintStatusReturn getPrintStatusUpdate(string PartnerKey, string UserName, string Password, string ClientCode) (generated, public)
Input message PartnerKey, UserName, Password, ClientCode (bare parts, not wrapped in a request type)
Output message PrintStatusReturn
Declared faults None declared
Called by Not called in this repository
Source Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl

Input message

Part Type Required Bound from Purpose
PartnerKey, UserName, Password, ClientCode string Not stated in the WSDL Not applicable — no call site Account credentials

Output message

Part Type Consumed by the caller Notes
StatusCode, StatusMessage int / string Not applicable — no call site In-band success/failure signal
StatusList (ArrayOfPrintReturn) array of complex type Not applicable — no call site One PrintReturn (QueueID plus status) per queued print item

Faults

Fault Surfaces as Handled at the call site
None declared Generic SOAP fault* Not applicable — no call site exists in this repository

Call site

This operation has no call site in this repository.

Notes

  • No call site found in repository source.

Coverage checklist

Operation Documented section Called by
getCertifiedLabel getCertifiedLabel SimpleCertifiedMailServiceProxy.GetCertifiedLabel
queuePrintItem queuePrintItem Not called in this repository
getDocumentStatus getDocumentStatus Not called in this repository
getDocumentStatusByRef getDocumentStatusByRef Not called in this repository
getDocumentStatusByItemID getDocumentStatusByItemID Not called in this repository
getProductionReport getProductionReport Not called in this repository
verifyUserCredentials verifyUserCredentials Not called in this repository
getPrintStatusUpdate getPrintStatusUpdate Not called in this repository

Note: Statements marked with † are derived from dependency library documentation via the Legends CLI. Statements marked with * were inferred from code structure or contextual evidence.

Sources

  • Services/SAIF.Services.Web.Proxies/SimpleCertifiedMailServiceProxy.cs
  • Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/ADS.wsdl
  • Services/SAIF.Services.Web.Proxies/Service References/SimpleCertifiedMail/Reference.svcmap