POST api/Resource/PreferenceBlock/V2/Submit

Submits a set of preference blocks for a given set of dates.

Request Information

URI Parameters

None.

Body Parameters

Contains the set of preferences along with the dates for which the preferences need to be set

PreferenceBlockSaveModel
NameDescriptionTypeAdditional information
Dates

Collection of date

Required

ScheduledPreferences

Collection of ScheduledPreferenceInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "Dates": [
    "2024-12-21T14:51:57.8252387+01:00",
    "2024-12-21T14:51:57.8252387+01:00"
  ],
  "ScheduledPreferences": [
    {
      "Preference": {
        "ID": 1,
        "Name": "sample string 2",
        "BeginTime": "sample string 3",
        "EndTime": "sample string 4",
        "Weight": 5,
        "IsWebPreference": true,
        "IsWebVariablePreference": true,
        "Symbol": "sample string 8"
      },
      "SchedulingID": 2,
      "IsConflicting": true,
      "Date": "2024-12-21T14:51:57.8252387+01:00",
      "BeginTime": "2024-12-21T14:51:57.8252387+01:00",
      "EndTime": "2024-12-21T14:51:57.8252387+01:00",
      "AcknowledgedID": 6
    },
    {
      "Preference": {
        "ID": 1,
        "Name": "sample string 2",
        "BeginTime": "sample string 3",
        "EndTime": "sample string 4",
        "Weight": 5,
        "IsWebPreference": true,
        "IsWebVariablePreference": true,
        "Symbol": "sample string 8"
      },
      "SchedulingID": 2,
      "IsConflicting": true,
      "Date": "2024-12-21T14:51:57.8252387+01:00",
      "BeginTime": "2024-12-21T14:51:57.8252387+01:00",
      "EndTime": "2024-12-21T14:51:57.8252387+01:00",
      "AcknowledgedID": 6
    }
  ]
}

application/xml, text/xml

Sample:
<PreferenceBlockSaveModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RostarCASWebAPI.Models">
  <Dates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>2024-12-21T14:51:57.8252387+01:00</d2p1:dateTime>
    <d2p1:dateTime>2024-12-21T14:51:57.8252387+01:00</d2p1:dateTime>
  </Dates>
  <ScheduledPreferences xmlns:d2p1="http://schemas.datacontract.org/2004/07/Paralax.Cas.Web.WebServices.Models">
    <d2p1:ScheduledPreferenceInfo>
      <d2p1:SchedulingID>2</d2p1:SchedulingID>
      <d2p1:Date>2024-12-21T14:51:57.8252387+01:00</d2p1:Date>
      <d2p1:BeginTime>2024-12-21T14:51:57.8252387+01:00</d2p1:BeginTime>
      <d2p1:EndTime>2024-12-21T14:51:57.8252387+01:00</d2p1:EndTime>
      <d2p1:AcknowledgedID>6</d2p1:AcknowledgedID>
      <d2p1:Preference>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:BeginTime>sample string 3</d2p1:BeginTime>
        <d2p1:EndTime>sample string 4</d2p1:EndTime>
        <d2p1:Weight>5</d2p1:Weight>
        <d2p1:IsWebPreference>true</d2p1:IsWebPreference>
        <d2p1:IsWebVariablePreference>true</d2p1:IsWebVariablePreference>
        <d2p1:Symbol>sample string 8</d2p1:Symbol>
      </d2p1:Preference>
      <d2p1:IsConflicting>true</d2p1:IsConflicting>
    </d2p1:ScheduledPreferenceInfo>
    <d2p1:ScheduledPreferenceInfo>
      <d2p1:SchedulingID>2</d2p1:SchedulingID>
      <d2p1:Date>2024-12-21T14:51:57.8252387+01:00</d2p1:Date>
      <d2p1:BeginTime>2024-12-21T14:51:57.8252387+01:00</d2p1:BeginTime>
      <d2p1:EndTime>2024-12-21T14:51:57.8252387+01:00</d2p1:EndTime>
      <d2p1:AcknowledgedID>6</d2p1:AcknowledgedID>
      <d2p1:Preference>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:BeginTime>sample string 3</d2p1:BeginTime>
        <d2p1:EndTime>sample string 4</d2p1:EndTime>
        <d2p1:Weight>5</d2p1:Weight>
        <d2p1:IsWebPreference>true</d2p1:IsWebPreference>
        <d2p1:IsWebVariablePreference>true</d2p1:IsWebVariablePreference>
        <d2p1:Symbol>sample string 8</d2p1:Symbol>
      </d2p1:Preference>
      <d2p1:IsConflicting>true</d2p1:IsConflicting>
    </d2p1:ScheduledPreferenceInfo>
  </ScheduledPreferences>
</PreferenceBlockSaveModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>