Get regularity pattern list for new frequency

POST /api/.../regularitypatterns?frequency{true}&displayonly={true}

Get regularity pattern list for new frequency.

Request Information

Parameters
Name Type Required Description
obj DtoRegPatternFrequencyInfo Yes Define this parameter in the request body.
frequency bool Yes Flag indicating to get formatted regularity patterns for new frequency. Value shuld be set to true
displayonly bool No Flag indicating execution will only return a result used for display purposes. When set to true, the data is validated, and a publication pattern is returned without persisting to the database. Default is true if not specified.
DtoRegPatternFrequencyInfo
Property Type Nullable Description
Frequency Int No 853/4/5 subfield $x. Pattern's frequency. FK, references to MfhdFrequencies(FrequencyID).
StartDate DateTime No Date when prediction for a pattern or template starts.
MfhdChronCaptions List of DtoSerialIssueRecordChronology objects Yes Publication Pattern Chronology Data. At least one level of Chronology or Enumeration is required in order to update a publication pattern
Example Body
application/json, text/json 
    
{
  "Frequency": 12,
  "StartDate":"2022-12-04",
  "MfhdChronCaptions":[{"ChronCap": 4,"LevelNum": 1,"IsAlter": true,"FormatID": 3,"ChronValue": "09" }, { "ChronCap": 7,"LevelNum": 2,"IsAlter": false,"FormatID": 2,"ChronValue": "mo" },{ "ChronCap": 2,"LevelNum": 3,"IsAlter": false,"FormatID": 2,"ChronValue": "23"}]        
}

Response Information

Example Response
application/json, text/json 
[
  {
    "RegPatternID": 0,
    "PubPatternID": 0,
    "PubCode": "p",
    "ChronCode": 2,
    "CodePattern": "SS",
    "Patterns": "23"
  },
  {
    "RegPatternID": 0,
    "PubPatternID": 0,
    "PubCode": "p",
    "ChronCode": 2,
    "CodePattern": "SS",
    "Patterns": "24"
  },
  {
    "RegPatternID": 0,
    "PubPatternID": 0,
    "PubCode": "p",
    "ChronCode": 2,
    "CodePattern": "SS",
    "Patterns": "21"
  },
  {
    "RegPatternID": 0,
    "PubPatternID": 0,
    "PubCode": "p",
    "ChronCode": 2,
    "CodePattern": "SS",
    "Patterns": "22"
  }
]

HTTP Response Codes

Code Description
200 Success
400 Bad request