Error Handling
Work Unit Create Error Messages
| Parameter | Description | Type | Example |
|---|---|---|---|
details | Describes message; prefixed by the associated parameter | Collection of Strings | [ "[exclusiveAccess] - Exclusive Access can have only a Y or an N value", ] |
level | Describes message level as ERROR or INFO | String | "ERROR" |
msg | Top-level message (used for errors and system messages) | String | "Request to create Work Unit was unsuccessful" |
msgs | Dictionary of message details (used for errors and system messages) | String | { "details": [ "[exclusiveAccess] - Exclusive Access can have only a Y or an N value", ], "level": "ERROR" } |
Work Unit Create Error Handling
When a request can't be processed, you will receive an error message at the top of the response as well as a detailed key error message within the body that indicates the field(s) in error.
Example error - problem with exclusiveAccess request parameter
The Create Empty Work Unit Web Service can give the following errors:
| Error | Affected parameter | Description |
|---|---|---|
| Email format is invalid. Comma-separated list of email addresses that each must contain an at symbol (@) followed by at least one period (.). Can be alphanumeric with the special characters hyphen (-), period (.), underscore (_), hash (#) | emailIds | Invalid Email |
| Exclusive Access can have only a Y or a N value | exclusiveAccess | Invalid Exclusive Access value |
| Work Unit Description has invalid length or format. Maximum length of Description is 200 characters. Can be alphanumeric with the special characters hyphen (-), forward slash (/), comma (,), period (.), space ( ) | description | Invalid Work Unit Description |
| Work Unit Name has invalid length or format. Maximum length of Work Unit Name is 10 characters. Can be alphanumeric with the special characters hyphen (-), comma (,), forward slash (/), or period (.) | workUnitName | Invalid Work Unit Name |
Work Unit Modify Error Handling
When a request can't be processed, you will receive an error message near the top of the response as well as a detailed key error message within the body that indicates the field(s) in error.
Example error - invalid effectiveDate request parameter
Example error - duplicate government/carrier/tariff in request
Example error - batches successfully reassigned with justification errors
The Modify Work Unit Web Service can give the following errors:
| Error | Affected parameter | Description |
|---|---|---|
| {0} is invalid | carrier | Carrier specified is not in correct format or is not a recognized carrier |
| {0} is invalid | government | Government specified is not in correct format or is not a recognized government |
| {0} is invalid | tariff | Tariff specified is not in correct format or is not a recognized tariff |
| {0} required | carrier | Carrier is a required parameter |
| {0} required | government | Government is a required parameter |
| {0} required | justificationText | Justification text is a required parameter |
| {0} required | tariff | Tariff is a required parameter |
| Carrier/Tariff combination is invalid | carrier | Carrier does not participate in the specified tariff |
| Data Change Work Units are eligible for this action | workUnitId | The Modify Work Unit API is available only for Data Change Work Units |
| Date provided in Work Unit ID {0} is invalid. Format should be DDMMMYY | workUnitId | Date format provided in the Work Unit ID is incorrect |
| Duplicate Justification record found. Government, Carrier & Tariff need to be unique | tariff | Justification must be unique for a carrier, tariff, and government |
| Effective Date provided is invalid. Format should be DDMMMYY | effectiveDate | Invalid format |
| Government, Justification Text, Carrier & Tariff are required fields | tariff | Required parameters |
| Invalid effective date on Justification | effectiveDate | Effective data must be today or greater than today |
| Invalid justification text is coded | justificationText | Justification text provided is not in correct format |
| Justification Text must not be blank | justificationText | Justification text provided must be 1 or more characters |
| Organization code in Work Unit {0} should be user's organization code | workUnitId | Work Unit specified must belong to the org requesting the justification update |
| Organization code is invalid | workUnitId,sourceWorkUnitId | Code is not in correct format or is not a recognized organization |
| Work Unit {0} not found | workUnitId,sourceWorkUnitId | Specified work unit is not found |
| Work Unit {0} status invalid for action | workUnitId,sourceWorkUnitId | Data change work unit must be have a status of Incomplete or Incomplete w/ errors |
| Work Unit ID {0} is invalid. Format should be XX-DDMMMYY-NNNNN, where XX is organization code, DDMMMYY is the create date, and NNNNN is Work Unit number. When multiple Work Units IDs are provided, they should be comma-separated. | workUnitId | Work Unit ID format is incorrect |
| When Work Unit ID is specified, at least one batch ID to reassign or justification is required | workUnitId | When only work unit id is specified and no reassign batch info or justifications are provided |
| Maximum of {0} batch IDs can be specified per request | rulesBatchIds,faresBatchIds,footnotesBatchIds | Too many batches are specified |
| Batch ID format is invalid. Specify batch owner ID followed by space and batch number | rulesBatchIds,faresBatchIds,footnotesBatchIds | Invalid batch format |
| Batch organization ID, source Work Unit organization ID and target WorkUnit organization ID must be the same | workUnitId,sourceWorkUnitId,rulesBatchIds,faresBatchIds,footnotesBatchIds | Batch org and WU org must be the same |
| For reassign, source work unit and target work unit cannot be the same | workUnitId,sourceWorkUnitId | Source and target work unit are the same |
| Duplicate batch numbers selected for reassign | rulesBatchIds,faresBatchIds,footnotesBatchIds | Duplicate batches selected for reassign |
| For reassign, both source Work Unit ID and batch ID to reassign are required | rulesBatchIds,faresBatchIds,footnotesBatchIds,sourceWorkUnitId | Source work unit and batch ID are required for reassign |
Work Unit Release Error Handling
When a request can't be processed, you will receive an error message at the top of the response as well as a detailed key error message within the body that indicates the field(s) in error.
Example error - invalid value for releaseType
Errors that occur when validating the eligibility of a work unit for release, test release, or scheduled release will be grouped together as shown below.
Example error - Work Unit cannot be released
Errors that occur when the user does not have Partner Access Control Release Authority from the work unit owner for release of a non-owned Work Unit are shown below.
Example error - invalid access
Errors that occur when the user has no data (batch data or DDC), and no batch, and no Tier 2 access with the Work Unit owner are shown below.
Example error - invalid access
The Release Work Unit Web Service can give the following errors:
| Error | Affected parameter | Description |
|---|---|---|
| workUnitIds and releaseType are required fields | workUnitIds, releaseType | Work Unit and Release Type are mandatory parameters |
| Work Unit ID {0} is invalid. Format should be XX-DDMMMYY-NNNNN, where XX is organization code, DDMMMYY is the create date, and NNNNN is Work Unit number. When multiple Work Units IDs are provided, they should be comma separated | workUnitIds | Work Unit format is incorrect |
| Date provided in Work Unit ID {0} is invalid. Format should be DDMMMYY | workUnitIds | Date format provided in the Work Unit is incorrect |
| Maximum of 10 Work Unit IDs can be specified | workUnitIds | Request can take 1 to 10 Work Units |
| Work Unit ID {0} is a duplicate | workUnitIds | Request must have unique Work Units Ids |
| Organization code is invalid | workUnitIds | Organization code in a Work Unit ID must match an existing organization code |
| Data Change, DDC and Empty Work Units are eligible for this action | workUnitIds | Scope of the Work Unit Release API are Data Change and DDC Work Units |
| Work Unit {0} could not be processed for the requested action | workUnitIds | |
| Work Unit {0} {1} {2} invalid status for release | workUnitIds | Work Units must have a status of Incomplete or Incomplete with Errors |
| Work Unit {0} {1} {2} invalid status for test release | workUnitIds | Work Units must have a status of Incomplete or Incomplete with Errors |
| Work Unit {0} not eligible for this action | workUnitIds | When the release type is Test Release and the Work Units specified is a DDC Work Unit |
| Valid Release Type values are R for immediate release, T for Test Release or S for Scheduled for Release | releaseType | Valid values for Release Type |
| When Release Type is either R for immediate release or T for Test Release, then Schedule Release Date is not required | scheduledReleaseDate | Scheduled Release Date is required only when Release Type is Scheduled for Release "S" |
| When ReleaseType of Scheduled (S) is specified, Scheduled Release Date is required | scheduledReleaseDate | Scheduled Release Date is required when Release Type is Scheduled for Release "S" |
| Scheduled Release Date is invalid. Format should be DDMMMYY hhmm | scheduledReleaseDate | Scheduled Release Date format is incorrect |
| Scheduled for Release Time must be greater than the time the work unit is released | scheduledReleaseDate | Scheduled Release Date and Time must be future Date and Time |
| Release Date cannot be greater than 7 days from today | scheduledReleaseDate | Work Units can only be scheduled up to 7 days in the future. |
| Ignore Fare Error can have only a Y or an N value | ignoreFareError | Invalid value provided on the Ignore Fare Error Indicator |
| Request should not contain Ignore Fare Error parameter when Test Release is specified | ignoreFareError | Ignore Fare Error action is ineligible for Work Units going through the Test Release process |
| You are not authorized to modify this work unit | workUnitIds | User has no data (batch data or DDC), and no batch, and no Tier 2 access with the Work Unit owner |
| User not Authorized for Requested Action | workUnitIds | User does not have Partner Access Control Release Authority from the work unit owner for release of a non-owned Work Unit |
Work Unit Summary Error Messages
| Parameter | Description | Type | Example |
|---|---|---|---|
details | Describes message; prefixed by the associated parameter | Collection of Strings | [ "[exclusiveAccess] - Exclusive Access can have only a Y or an N value", ] |
level | Describes message level as "ERROR" or "INFO" | String | "INFO" |
message | Describes the filing validation error or warning that occurred during the release or test release process | String | "No matching Fare Class(es) found for Addon" |
msg | Top-level message | String | "Request to create Work Unit was unsuccessful" |
msgs | Dictionary of message details | String | { "details": [ "[exclusiveAccess] - Exclusive Access can have only a Y or an N value", ], "level": "ERROR" } |
subDetails | Provides data specific details of the filing validation error or warning | String | [ "Carrier:91,Tariff:EUAFZ,Rule/Footnote:1B,Category:23,Sequence:100000,Eff Date:16AUG18,Disc Date:,Batch Id:91 991" ] |
Work Unit Summary Error Handling
When a request can't be processed and results in a no-match, you will receive an error message at the top of the response as well as a detailed error message within the body that indicates the field(s) in error.
Example error - request did not include the expected parameters
Example error - no matches for Work Unit Name and Work Unit Create Date
Example error - Invalid value provided for RetrieveUploadErrors Indicator
Example error - API response with more than 400 errors/warnings
Example error - API response when the user does not have Tier 2 access to view their partner work units when the request has Work Unit ID
Example error - API response when the user does not have Tier 2 access to view their partner work units when the request has Work Unit Name, Date and Partner Organization Code
Example error - Invalid value provided for PartnerOrgCode parameter
The Retrieve Work Unit Summary Content Web Service can give the following errors:
| Error | Affected parameter | Description |
|---|---|---|
| Work Unit createDate is invalid. Format should be DDMMMYY. | createDate | Invalid Create Date |
| Date provided in Work Unit ID {0} is invalid. Format should be DDMMMYY. | workUnitId | Invalid Date in the Work Unit ID |
| Work Unit Name has invalid length or format. Maximum length of Work Unit Name is 10 bytes. Can be alphanumeric with the special characters hyphen (-), comma (,), forward slash (/), period (.). | workUnitName | Invalid Name |
| Organization code in Work Unit ATP-12MAR18-90 should be the user's organization code | workUnitId | Invalid organization in the Work Unit ID |
| Work Unit ID {0} is invalid. Format should be XXX-DDMMMYY-NNNNN, where XXX is organization code, DDMMMYY is the create date, and NNNNN is Work Unit number. | workUnitId | Invalid Work Unit ID format |
| The request should have either Work Unit ID or Work Name, Date and PartnerOrgCode (optional). If Date is not provided, today's date will be applied. Partner work units will be retrieved only if PartnerOrgCode is provided in the request | workUnitId, workUnitName, createDate,partnerOrgCode | The request does not have mandatory parameters |
| Retrieve Filing Errors can only have a Y or a N value | retrieveFilingErrors | Invalid value provided for the Retrieve Filing Error Indicator |
| Retrieve Justifications can have only a Y or an N value | retrieveJustifications | Invalid value provided on the Retrieve Justifications Indicator |
| RetrieveUploadErrors indicator can have only a Y or an N value | retrieveUploadErrors | Invalid value provided for RetrieveUploadErrors Indicator |
| Invalid format. Expected format is yyyy-MM-dd'T'HH:mm:ss.SSS | afterTimeStamp | Invalid afterTimeStamp format |
| You are not authorized to view this work unit | workUnitId | User does not have Tier 2 access to view their partner work units |
| Organization code is invalid | partnerOrgCode | Invalid Partner Organization Code |