Load weekly calendar overrides

post

https://{env}.gainsystems.com/api/v1/calendar/weekly

Loads weekly calendar overrides into GAINS X; one record adds or removes working time at one location on the listed days of the week, between its start and end dates. Records that pass validation are loaded asynchronously; follow the returned task. See Demand Planning.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

LocationCode

string

required

length between 1 and 80

Location code the calendar override applies to

OverrideType

string

required

^([EI])$

Whether the override adds or removes working time. Accepted values: 'E' (exclude) and 'I' (include)

Description

string

length between 0 and 100

Free-text note describing why the override exists

StartDate

date

required

Required. First day the override is in effect (YYYY-MM-DD)

EndDate

date

required

Required. Last day the override is in effect (YYYY-MM-DD); must be on or after StartDate

ModifiedSchedule

array of strings

required

length ≥ 1

The days of the week the override applies to, within the start and end date range. Lowercase day names, monday to sunday, with no duplicates

ModifiedSchedule*

The days of the week the override applies to, within the start and end date range. Lowercase day names, monday to sunday, with no duplicates

AppliesTo

array of strings

required

length ≥ 1

The activities the override applies to. Accepted values: 'receive', 'ship', 'production', 'release', 'delivery', lowercase, with no duplicates

AppliesTo*

The activities the override applies to. Accepted values: 'receive', 'ship', 'production', 'release', 'delivery', lowercase, with no duplicates

Headers

Idempotency-Key

string

length ≤ 255

Optional key that makes a retry safe. A request repeating a key already used on this endpoint within the last 24 hours is refused with 400 and nothing is submitted again. A UUID is recommended; at most 255 characters

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

202Accepted; poll the returned task for progress

207Partially accepted; rejected records are listed in the response

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

422Nothing was accepted and no task was created. Either every record failed validation, and the body lists each one under RejectedRecords with Status "RejectedFailedProcessing"; or the payload was empty or held more than 1000 records, and the body carries a Reason

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

429The service is still ingesting previously submitted data and did not accept this batch. Nothing was persisted; retry the same batch after the interval given in the Retry-After header

500Unexpected server error

503GAINS is temporarily unavailable, or inbound integration is switched off in GAINS X: GAINS X could not be reached or returned an error, or your credentials could not be checked. Retry later, or contact your GAINS representative if inbound integration is not enabled

504GAINS X did not respond in time. Retry later