GET v1/xpresscollect/{facilityId}/custommessages

Gets the xpress collect facility custom messages.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

XpressCollectFacilityCustomMessagesBindingModel

Name	Type	Additional information
CustomMessages	Collection of XpressCollectFacilityCustomMessage	None.
Errors	Collection of Exception	None.
IsSuccess	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomMessages": [
    {
      "Id": "ad13adc8-3461-4902-b7b4-a0c682b4c200",
      "Name": "sample string 1",
      "SmsMessage": "sample string 2",
      "EmailMessage": "sample string 3",
      "FacilityName": "sample string 4",
      "FacilityId": "257bf1d0-3e7b-485b-a146-09899ca47923",
      "LiveHtmlDocsId": "6438106e-c827-4f90-accc-7c5f7ff223a3"
    },
    {
      "Id": "ad13adc8-3461-4902-b7b4-a0c682b4c200",
      "Name": "sample string 1",
      "SmsMessage": "sample string 2",
      "EmailMessage": "sample string 3",
      "FacilityName": "sample string 4",
      "FacilityId": "257bf1d0-3e7b-485b-a146-09899ca47923",
      "LiveHtmlDocsId": "6438106e-c827-4f90-accc-7c5f7ff223a3"
    }
  ],
  "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:

<XpressCollectFacilityCustomMessagesBindingModel 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>
  <CustomMessages>
    <XpressCollectFacilityCustomMessage>
      <EmailMessage>sample string 3</EmailMessage>
      <FacilityId>257bf1d0-3e7b-485b-a146-09899ca47923</FacilityId>
      <FacilityName>sample string 4</FacilityName>
      <Id>ad13adc8-3461-4902-b7b4-a0c682b4c200</Id>
      <LiveHtmlDocsId>6438106e-c827-4f90-accc-7c5f7ff223a3</LiveHtmlDocsId>
      <Name>sample string 1</Name>
      <SmsMessage>sample string 2</SmsMessage>
    </XpressCollectFacilityCustomMessage>
    <XpressCollectFacilityCustomMessage>
      <EmailMessage>sample string 3</EmailMessage>
      <FacilityId>257bf1d0-3e7b-485b-a146-09899ca47923</FacilityId>
      <FacilityName>sample string 4</FacilityName>
      <Id>ad13adc8-3461-4902-b7b4-a0c682b4c200</Id>
      <LiveHtmlDocsId>6438106e-c827-4f90-accc-7c5f7ff223a3</LiveHtmlDocsId>
      <Name>sample string 1</Name>
      <SmsMessage>sample string 2</SmsMessage>
    </XpressCollectFacilityCustomMessage>
  </CustomMessages>
</XpressCollectFacilityCustomMessagesBindingModel>