PUT v1/xpresscollect/{facilityId}/settings

Updates the xpress collect facility settings.

Request Information

URI Parameters

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

Body Parameters

The settings.

XpressCollectFacilitySettings

Name	Type	Additional information
IsActive	boolean	None.
ActivityLog_RentDueMessageSentToTenant	boolean	None.
ActivityLog_NotificationLinkClicked	boolean	None.
ActivityLog_CallNowClicked	boolean	None.
ActivityLog_CustomMessageSentToTenant	boolean	None.
ActivityLog_PaymentMade	boolean	None.
PreventSundayNotification	boolean	None.
PreventHolidayNotifications	boolean	None.
SendMessageTime	date	None.
EnablePaymentRestrictionDays	boolean	None.
PaymentRestrictionDays	integer	None.
EnablePreventMessageWhenBalanceBelow	boolean	None.
PreventMessageWhenBalanceBelowAmount	decimal number	None.
OverrideBasePaymentURL	boolean	None.
PaymentUrlBase	string	None.
XpressCollectPhoneNumber	string	None.
FacilityUtcOffset	integer	None.
ManualCallTextPrompt	string	None.
ManualCallPhonePrompt	string	None.
EnableManualCallRecording	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "IsActive": true,
  "ActivityLog_RentDueMessageSentToTenant": true,
  "ActivityLog_NotificationLinkClicked": true,
  "ActivityLog_CallNowClicked": true,
  "ActivityLog_CustomMessageSentToTenant": true,
  "ActivityLog_PaymentMade": true,
  "PreventSundayNotification": true,
  "PreventHolidayNotifications": true,
  "SendMessageTime": "2021-10-18T10:36:54.5080664-07:00",
  "EnablePaymentRestrictionDays": true,
  "PaymentRestrictionDays": 1,
  "EnablePreventMessageWhenBalanceBelow": true,
  "PreventMessageWhenBalanceBelowAmount": 1.1,
  "OverrideBasePaymentURL": true,
  "PaymentUrlBase": "sample string 12",
  "XpressCollectPhoneNumber": "sample string 13",
  "FacilityUtcOffset": 14,
  "ManualCallTextPrompt": "sample string 15",
  "ManualCallPhonePrompt": "sample string 16",
  "EnableManualCallRecording": true
}

application/xml, text/xml

Sample:

<XpressCollectFacilitySettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <ActivityLog_CallNowClicked>true</ActivityLog_CallNowClicked>
  <ActivityLog_CustomMessageSentToTenant>true</ActivityLog_CustomMessageSentToTenant>
  <ActivityLog_NotificationLinkClicked>true</ActivityLog_NotificationLinkClicked>
  <ActivityLog_PaymentMade>true</ActivityLog_PaymentMade>
  <ActivityLog_RentDueMessageSentToTenant>true</ActivityLog_RentDueMessageSentToTenant>
  <EnableManualCallRecording>true</EnableManualCallRecording>
  <EnablePaymentRestrictionDays>true</EnablePaymentRestrictionDays>
  <EnablePreventMessageWhenBalanceBelow>true</EnablePreventMessageWhenBalanceBelow>
  <FacilityUtcOffset>14</FacilityUtcOffset>
  <IsActive>true</IsActive>
  <ManualCallPhonePrompt>sample string 16</ManualCallPhonePrompt>
  <ManualCallTextPrompt>sample string 15</ManualCallTextPrompt>
  <OverrideBasePaymentURL>true</OverrideBasePaymentURL>
  <PaymentRestrictionDays>1</PaymentRestrictionDays>
  <PaymentUrlBase>sample string 12</PaymentUrlBase>
  <PreventHolidayNotifications>true</PreventHolidayNotifications>
  <PreventMessageWhenBalanceBelowAmount>1.1</PreventMessageWhenBalanceBelowAmount>
  <PreventSundayNotification>true</PreventSundayNotification>
  <SendMessageTime>2021-10-18T10:36:54.5080664-07:00</SendMessageTime>
  <XpressCollectPhoneNumber>sample string 13</XpressCollectPhoneNumber>
</XpressCollectFacilitySettings>

Response Information

Resource Description

UpdateXpressCollectFacilitySettingsBindingModel

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:

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