POST v1/xpresscollect/{facilityId}/custommessage

Inserts the xpress collect facility custom message.

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId	The facility identifier.	globally unique identifier	Required

Body Parameters

The custom message.

XpressCollectFacilityCustomMessage

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
SmsMessage	string	None.
EmailMessage	string	None.
FacilityName	string	None.
FacilityId	globally unique identifier	None.
LiveHtmlDocsId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "28c1c3fa-9634-4d27-9e25-e5fe036e0f1e",
  "Name": "sample string 1",
  "SmsMessage": "sample string 2",
  "EmailMessage": "sample string 3",
  "FacilityName": "sample string 4",
  "FacilityId": "256347f8-0d23-4b50-95e4-047ecee7ac85",
  "LiveHtmlDocsId": "4aeb8ba8-606d-4dbf-ac22-faafe3f635af"
}

application/xml, text/xml

Sample:

<XpressCollectFacilityCustomMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <EmailMessage>sample string 3</EmailMessage>
  <FacilityId>256347f8-0d23-4b50-95e4-047ecee7ac85</FacilityId>
  <FacilityName>sample string 4</FacilityName>
  <Id>28c1c3fa-9634-4d27-9e25-e5fe036e0f1e</Id>
  <LiveHtmlDocsId>4aeb8ba8-606d-4dbf-ac22-faafe3f635af</LiveHtmlDocsId>
  <Name>sample string 1</Name>
  <SmsMessage>sample string 2</SmsMessage>
</XpressCollectFacilityCustomMessage>

Response Information

Resource Description

InsertXpressCollectFacilityCustomMessageBindingModel

Name	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:

<InsertXpressCollectFacilityCustomMessageBindingModel 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>
</InsertXpressCollectFacilityCustomMessageBindingModel>