POST v1/xpresscollect/{facilityId}/scheduledmessage

Inserts the xpress collect facility scheduled message.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

globally unique identifier

Required

Body Parameters

The scheduled message.

XpressCollectFacilityScheduledMessage
NameDescriptionTypeAdditional 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": "cefa14f0-de60-40f2-8945-edaa907c6bd2",
  "Name": "sample string 1",
  "DaysLate": 2,
  "SendSms": true,
  "SendEmail": true,
  "ManualCall": true,
  "Message": "sample string 6",
  "LiveHtmlDocsId": "11f3f1af-67ef-48ab-80d2-4a62bf9efa8c",
  "FacilityName": "sample string 7",
  "FacilityId": "dc369d6f-0588-4de7-a2e9-820a0d0721ec"
}

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>dc369d6f-0588-4de7-a2e9-820a0d0721ec</FacilityId>
  <FacilityName>sample string 7</FacilityName>
  <Id>cefa14f0-de60-40f2-8945-edaa907c6bd2</Id>
  <LiveHtmlDocsId>11f3f1af-67ef-48ab-80d2-4a62bf9efa8c</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

InsertXpressCollectFacilityScheduledMessageBindingModel
NameDescriptionTypeAdditional 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:
<InsertXpressCollectFacilityScheduledMessageBindingModel 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>
</InsertXpressCollectFacilityScheduledMessageBindingModel>