GET v1/xpresscollect/{facilityId}/scheduledmessages
Gets the xpress collect facility scheduled 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
XpressCollectFacilityScheduledMessagesBindingModelName | Description | Type | Additional information |
---|---|---|---|
ScheduledMessages | Collection of XpressCollectFacilityScheduledMessage |
None. |
|
Errors | Collection of Exception |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ScheduledMessages": [ { "Id": "30a6c76b-d8e6-43e8-a658-8ac79a3e1d92", "Name": "sample string 1", "DaysLate": 2, "SendSms": true, "SendEmail": true, "ManualCall": true, "Message": "sample string 6", "LiveHtmlDocsId": "7479634d-e4c4-47a8-9289-9404e41df0ae", "FacilityName": "sample string 7", "FacilityId": "bd207269-d1d2-48ab-9b0d-460e39cc6b9d" }, { "Id": "30a6c76b-d8e6-43e8-a658-8ac79a3e1d92", "Name": "sample string 1", "DaysLate": 2, "SendSms": true, "SendEmail": true, "ManualCall": true, "Message": "sample string 6", "LiveHtmlDocsId": "7479634d-e4c4-47a8-9289-9404e41df0ae", "FacilityName": "sample string 7", "FacilityId": "bd207269-d1d2-48ab-9b0d-460e39cc6b9d" } ], "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:
<XpressCollectFacilityScheduledMessagesBindingModel 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> <ScheduledMessages> <XpressCollectFacilityScheduledMessage> <DaysLate>2</DaysLate> <FacilityId>bd207269-d1d2-48ab-9b0d-460e39cc6b9d</FacilityId> <FacilityName>sample string 7</FacilityName> <Id>30a6c76b-d8e6-43e8-a658-8ac79a3e1d92</Id> <LiveHtmlDocsId>7479634d-e4c4-47a8-9289-9404e41df0ae</LiveHtmlDocsId> <ManualCall>true</ManualCall> <Message>sample string 6</Message> <Name>sample string 1</Name> <SendEmail>true</SendEmail> <SendSms>true</SendSms> </XpressCollectFacilityScheduledMessage> <XpressCollectFacilityScheduledMessage> <DaysLate>2</DaysLate> <FacilityId>bd207269-d1d2-48ab-9b0d-460e39cc6b9d</FacilityId> <FacilityName>sample string 7</FacilityName> <Id>30a6c76b-d8e6-43e8-a658-8ac79a3e1d92</Id> <LiveHtmlDocsId>7479634d-e4c4-47a8-9289-9404e41df0ae</LiveHtmlDocsId> <ManualCall>true</ManualCall> <Message>sample string 6</Message> <Name>sample string 1</Name> <SendEmail>true</SendEmail> <SendSms>true</SendSms> </XpressCollectFacilityScheduledMessage> </ScheduledMessages> </XpressCollectFacilityScheduledMessagesBindingModel>