Get regularity pattern display string

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

Get regularity pattern display string, CodePattern and Patterns.

Request Information

Parameters
Name Type Required Description
dtoRegPatternValidateData DtoRegPatternValidateData Yes Define this parameter in the request body.
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.
DtoRegPatternValidateData
Property Type Nullable Description
PubCode Int No Required. Publication code. Valid values: 99, 111 and 112
CalUnit String No Required. Calendar Unit. Valid values: 1, 2, 4, 5, 6, 7, and 8
From String No Required. Format depends on calendar unit.
  • Year: 1753 - 9999
  • Month: 1 - 12
    • January to December
  • Season: 21 - 24
    • 21: Spring
    • 22: Summer
    • 23: Autumn
    • 24: Winter
  • Week of month: 99, 98, 97, 00, 01, 02, 03, 04, 05
    • 99 - Last
    • 98 - Next to Last
    • 97 - Third to Last
    • 00 - Every
    • 01 - First
    • 02 - Second
    • 03 - Third
    • 04 - Fourth
    • 05 - Fifth
  • Week of year: 1 - 53
  • Day of month: 1 - 31
  • Day of week: su, mo, tu, we, th, fr, sa.
    • Sunday to Saturday
To String No Required. Format depends on calendar unit.
  • Year: 1753 - 9999
  • Month: 1 - 12
    • January to December
  • Season: 21 - 24
    • 21: Spring
    • 22: Summer
    • 23: Autumn
    • 24: Winter
  • Week of month: 99, 98, 97, 00, 01, 02, 03, 04, 05
    • 99 - Last
    • 98 - Next to Last
    • 97 - Third to Last
    • 00 - Every
    • 01 - First
    • 02 - Second
    • 03 - Third
    • 04 - Fourth
    • 05 - Fifth
  • Week of year: 1 - 53
  • Day of month: 1 - 31
  • Day of week: su, mo, tu, we, th, fr, sa.
    • Sunday to Saturday
Example Body
application/json, text/json
    
{
  "PubCode": 99,
  "CalUnit": 5,
  "From": "21",
  "To": "22"
}

Response Information

Example Response
application/json, text/json
{
    "Success": true,
    "Message": "cw 21/22",
    "CodePattern": "ww",
    "Patterns": "21/22"
}

HTTP Response Codes

Code Description
200 Success
400 Bad request