POST v1/xpresscollect/{facilityId}/sendmessage/email
Sends the message email.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
facilityId |
The facility identifier. |
globally unique identifier |
Required |
Body Parameters
The parameters.
SendMessageEmailParametersName | Description | Type | Additional information |
---|---|---|---|
LiveHtmlDocsId | globally unique identifier |
None. |
|
issnTenantId | globally unique identifier |
None. |
|
tenantEmail | string |
None. |
|
message | string |
None. |
|
sentBy | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "LiveHtmlDocsId": "51467745-1324-4ed7-85d7-999443de08fa", "issnTenantId": "639f2404-6c8f-4ac3-8bb6-8626c40d1a9f", "tenantEmail": "sample string 3", "message": "sample string 4", "sentBy": "sample string 5" }
application/xml, text/xml
Sample:
<SendMessageEmailParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <LiveHtmlDocsId>51467745-1324-4ed7-85d7-999443de08fa</LiveHtmlDocsId> <issnTenantId>639f2404-6c8f-4ac3-8bb6-8626c40d1a9f</issnTenantId> <message>sample string 4</message> <sentBy>sample string 5</sentBy> <tenantEmail>sample string 3</tenantEmail> </SendMessageEmailParameters>
Response Information
Resource Description
EmailResponseBindingModelName | Description | Type | Additional information |
---|---|---|---|
Errors | Collection of Exception |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Errors": [ { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null }, { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null } ], "IsSuccess": true }
application/xml, text/xml
Sample:
<EmailResponseBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> </Errors> <IsSuccess>true</IsSuccess> </EmailResponseBindingModel>