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
XpressCollectFacilityCustomMessagesBindingModelName | Description | 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": "08099869-4c54-45ce-86b3-7406deb4483c", "Name": "sample string 1", "SmsMessage": "sample string 2", "EmailMessage": "sample string 3", "FacilityName": "sample string 4", "FacilityId": "865b0e22-10bd-4989-950e-38320e2c6c00", "LiveHtmlDocsId": "df6d2a4c-5701-46c3-b34a-9f75c9f32af4" }, { "Id": "08099869-4c54-45ce-86b3-7406deb4483c", "Name": "sample string 1", "SmsMessage": "sample string 2", "EmailMessage": "sample string 3", "FacilityName": "sample string 4", "FacilityId": "865b0e22-10bd-4989-950e-38320e2c6c00", "LiveHtmlDocsId": "df6d2a4c-5701-46c3-b34a-9f75c9f32af4" } ], "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>865b0e22-10bd-4989-950e-38320e2c6c00</FacilityId> <FacilityName>sample string 4</FacilityName> <Id>08099869-4c54-45ce-86b3-7406deb4483c</Id> <LiveHtmlDocsId>df6d2a4c-5701-46c3-b34a-9f75c9f32af4</LiveHtmlDocsId> <Name>sample string 1</Name> <SmsMessage>sample string 2</SmsMessage> </XpressCollectFacilityCustomMessage> <XpressCollectFacilityCustomMessage> <EmailMessage>sample string 3</EmailMessage> <FacilityId>865b0e22-10bd-4989-950e-38320e2c6c00</FacilityId> <FacilityName>sample string 4</FacilityName> <Id>08099869-4c54-45ce-86b3-7406deb4483c</Id> <LiveHtmlDocsId>df6d2a4c-5701-46c3-b34a-9f75c9f32af4</LiveHtmlDocsId> <Name>sample string 1</Name> <SmsMessage>sample string 2</SmsMessage> </XpressCollectFacilityCustomMessage> </CustomMessages> </XpressCollectFacilityCustomMessagesBindingModel>