PUT v1/xpresscollect/{facilityId}/scheduledmessage
Updates the xpress collect facility scheduled message.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId |
The facility identifier. |
globally unique identifier |
Required |
Body Parameters
The scheduled message.
XpressCollectFacilityScheduledMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| DaysLate | integer |
None. |
|
| SendSms | boolean |
None. |
|
| SendEmail | boolean |
None. |
|
| ManualCall | boolean |
None. |
|
| Message | string |
None. |
|
| LiveHtmlDocsId | globally unique identifier |
None. |
|
| FacilityName | string |
None. |
|
| FacilityId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "23aefd86-1ea4-45ab-8f51-143d1c0c6887",
"Name": "sample string 1",
"DaysLate": 2,
"SendSms": true,
"SendEmail": true,
"ManualCall": true,
"Message": "sample string 6",
"LiveHtmlDocsId": "d4cea493-1f81-40b0-a41a-92222839f8b2",
"FacilityName": "sample string 7",
"FacilityId": "b71dde8d-bb16-4403-a04f-5a39b8201fc9"
}
application/xml, text/xml
Sample:
<XpressCollectFacilityScheduledMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <DaysLate>2</DaysLate> <FacilityId>b71dde8d-bb16-4403-a04f-5a39b8201fc9</FacilityId> <FacilityName>sample string 7</FacilityName> <Id>23aefd86-1ea4-45ab-8f51-143d1c0c6887</Id> <LiveHtmlDocsId>d4cea493-1f81-40b0-a41a-92222839f8b2</LiveHtmlDocsId> <ManualCall>true</ManualCall> <Message>sample string 6</Message> <Name>sample string 1</Name> <SendEmail>true</SendEmail> <SendSms>true</SendSms> </XpressCollectFacilityScheduledMessage>
Response Information
Resource Description
UpdateXpressCollectFacilityScheduledMessageBindingModel| 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:
<UpdateXpressCollectFacilityScheduledMessageBindingModel 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>
</UpdateXpressCollectFacilityScheduledMessageBindingModel>