Use the Retrieve Work Unit Summary Content Web Service to obtain details on the contents or check the status and progress of your released work unit and retrieve filing validation errors and/or warnings that occurred. Additionally, you can retrieve justifications associated to the work unit.

To retrieve complete work unit details, including upload errors and justifications, use the Work Unit ID with the appropriate parameters.

Since the Work Unit Name is not unique and can be shared across multiple work units, the information provided in the Work Unit Name method is limited and does not return upload errors or warnings.

A new field, workUnitProgress, has been added to the Retrieve Work Unit Summary API response and will be returned when applicable. The workUnitProgress field provides the estimated processing progress of a work unit as a percentage value ranging from 0% to 100%. The field will only be returned for Data Change work units with one of the following statuses: Queued, Preparing, Validating, or Packaging.

Request

Your request to the Retrieve Work Unit Summary Content Web Service must provide a valid OAuth access token and a userId in the header. See Authentication for more information. You must also specify at least one search criteria parameter in the request body.

Requests can be made by specifying at least one of the following search criteria parameters in the URL query string:

Work Unit ID

This method supports full retrieval of all summary details:

• Work Unit ID

With optional parameters, you can also retrieve:

• Filing errors
• Justifications
• Upload errors and warnings

Work Unit Name

You can retrieve summary information by providing:

• Work Unit Name, or

• Work Unit Name & Create Date

  With optional parameters, you can also retrieve:

  • Filing errors
  • Justifications

📝 Upload errors and warnings are not returned when the Work Unit Name parameter is provided.

Users can also retrieve their partner work units by specifying either the Work Unit ID or the combination of Work Unit Name, Work Unit Create Date, and the Partner Organization Code in the request. 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. If the non-owning work unit carrier actor has no Tier 2 access with the work unit owner, the actor cannot view the work unit.

Users can specify in the request the option to retrieve filing validation errors and/or warnings that may have occurred during the release, test release or scheduled released of the work unit. If filing validation errors and/or warnings exist, the API response will include a sample of each unique error and/or warning. This feature provides users further details on the state of their work unit to assist with auditing and troubleshooting.

retrieveFilingErrors is an optional request parameter, which uses a "Y"/"N" indicator to determine whether to retrieve filing errors and/or warnings.

Users can specify the option to retrieve Upload errors and/or warnings that may have occurred during rules or footnotes upload and fares batch data errors and/or warnings during fares upload through the parameter retrieveUploadErrors, which is a "Y"/"N" indicator. They can also opt to display errors associated to upload attempts on or after the selected timestamp by using the parameter afterTimestamp. API request with no timestamp display all errors related to all upload attempts. The API response will list up to 400 error messages for each product (Fares, Rules, and Footnotes). If there are more than 400 errors per product, please manually log in to the 3270 Upload Transmission Job Status Display to view all errors.

Data providers may also opt in the request to retrieve justifications associated with the specified work units through the parameter retrieveJustifications, which is a "Y"/"N" indicator

Request Header Parameters

See Authentication for full instructions on header parameters needed for authentication.

Request URL Parameters

Requests can be made by specifying at least one of the following URL parameters:

Response

Upon successful processing of a request, a response is provided with the following details about the matched work unit(s) and batch(es):

Response Parameters

Work Unit Details

Batch Details

Rules Upload Errors and Warnings

Footnotes upload Errors and Warnings

Fares Upload Errors and Warnings

Justifications

Example Requests and Responses

The following examples show what the Retrieve Work Unit Summary Content Web Service would return based on the indicated requests.

Request with Work Unit ID and Retrieve Filing Error Parameter Specified

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?createDate=&workUnitName=&workUnitId=91-16AUG18-47&retrieveFilingErrors=Y

Response

{
  totalWorkUnits: 1,
  workUnitId: "91-16AUG18-47",
  workUnits: [
    {
      workUnitId: "91-16AUG18-47",
      workUnitName: "",
      workUnitStatus: "Incomplete w/Errors",
      exclusiveAccess: "Y",
      distributedTime: "9999-12-31 00:00:00.0",
      description: "",
      contents: [
        {
          batchID: "9100991",
          batchType: "Footnotes",
          carrier: "91",
          global: "EH",
          recordCount: 1,
          tariff: "EUAFZ",
          validationLevel: "Partial",
        },
        {
          batchID: "9102476",
          batchType: "Rules",
          carrier: "91",
          global: "EH",
          recordCount: 4,
          tariff: "IPREUAZ",
          validationLevel: "Partial",
        },
        {
          batchID: "9110939",
          batchType: "Fares",
          carrier: "91",
          global: "EH",
          recordCount: 2,
          tariff: "EUAFZ",
          validationLevel: "Partial",
        },
        {
          batchID: "9110940",
          batchType: "Fares",
          carrier: "91",
          global: "EH",
          recordCount: 2,
          tariff: "AARBAEZ",
          validationLevel: "Partial",
        },
      ],
      msgs: [
        {
          level: "WU RELEASE ERROR",
          details: [
            {
              message:
                "Effective date of the Fare Class must be equal to or one day greater than work unit release date as allowed by the Rules tariff",
              subDetails: [
                "Carrier:91,Tariff:IPREUAZ,Rule:8171,Fare Class:LA8171,Sequence:5000000,Display Type:E,Eff Date:16AUG18,Disc Date:,Batch Id:91 2476",
              ],
            },
            {
              message:
                "Effective date of the rule category must be equal to or one day greater than work unit release date as allowed by the Rules tariff",
              subDetails: [
                "Carrier:91,Tariff:IPREUAZ,Rule/Footnote:8171,Category:01,Sequence:5000000,Eff Date:16AUG18,Disc Date:,Batch Id:91 2476",
              ],
            },
            {
              message:
                "Effective date of the RBD must be equal to or one day greater than work unit release date as allowed by the Rules tariff",
              subDetails: [
                "Carrier:91,Tariff:IPREUAZ,Rule:0000,Eff Date:16AUG18,Disc Date:,Batch Id:91 2476",
                "Carrier:91,Tariff:IPREUAZ,Rule:8171,Eff Date:16AUG18,Disc Date:,Batch Id:91 2476",
              ],
            },
            {
              message:
                "Effective date of the Footnote must be equal to or one day greater than work unit release date as allowed by the Footnote tariff",
              subDetails: [
                "Carrier:91,Tariff:EUAFZ,Rule/Footnote:1B,Category:23,Sequence:100000,Eff Date:16AUG18,Disc Date:,Batch Id:91 991",
              ],
            },
          ],
        },
        {
          level: "WU RELEASE WARNINGS",
          details: [
            {
              message: "No matching Fare Class(es) found for Addon",
              subDetails: [
                "Carrier:91,Tariff:AARBAEZ,Zone:100,Nation:BE,Orig:BRU,Nation:ES,Dest:LEU,Fare Class:A*****,OW/RT:1,Routing:0000,Footnote:,Eff Date:17AUG18,Disc Date:,Batch Id:91 10940",
              ],
            },
          ],
        },
      ],
    },
  ],
}

Request with Work Unit ID and Retrieve Justification Parameter Specified

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?workUnitId=ATP-14MAR19-14&retrieveFilingErrors=N&retrieveJustifications=Y

Response

{
  retrieveFilingErrors: "N",
  retrieveJustifications: "Y",
  totalWorkUnits: 1,
  workUnitId: "ATP-14MAR19-14",
  workUnits: [
    {
      workUnitId: "ATP-14MAR19-14",
      workUnitName: "3",
      workUnitStatus: "Distributed",
      exclusiveAccess: "Y",
      distributedTime: "2019-03-15 00:03:08.315495",
      description: "",
      contents: [
        {
          batchID: "8118612",
          batchType: "Fares",
          carrier: "91",
          fanNumber: "14MAR19-AAG",
          global: "AT",
          recordCount: 1,
          tariff: "AUSA",
          validationLevel: "Full",
        },
      ],
      justifications: [
        {
          carrier: "91",
          effectiveDate: "",
          govemment: "DE",
          justificationText: "ADDING FARES TO REMAIN COMPETITIVE",
          tariff: "AUSA",
        },
      ],
    },
  ],
}

Request with Work Unit ID and Retrieve Upload Errors Parameter Specified

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?workUnitId=ATP-18dec19-8&retrieveUploadErrors=Y&afterTimestamp=2019-07-24T00:01:00.000

Response

{
  afterTimestamp: "2019-07-24T00:01:00.000",
  retrieveFilingErrors: "Y",
  retrieveJustifications: "N",
  retrieveUploadErrors: "Y",
  totalWorkUnits: 1,
  workUnitId: "ATP-18DEC19-8",
  workUnits: [
    {
      workUnitId: "ATP-18DEC19-8",
      workUnitName: "106673",
      workUnitStatus: "Incomplete",
      exclusiveAccess: "Y",
      distributedTime: "9999-12-31 00:00:00.0",
      description: "RULES UPLOAD",
      contents: [
        {
          batchID: "8111001",
          batchType: "Rules",
          carrier: "91",
          global: "AT",
          recordCount: 3,
          tariff: "IPRA",
          validationLevel: "Full",
        },
        {
          batchID: "8110089",
          batchType: "Fares",
          carrier: "91",
          global: "AT",
          recordCount: 0,
          tariff: "TAFP",
          validationLevel: "Partial",
        },
        {
          batchID: "8110088",
          batchType: "Footnotes",
          carrier: "91",
          global: "AT",
          recordCount: 0,
          tariff: "TAFP",
          validationLevel: "Partial",
        },
      ],
      uploadErrorsWarnings: {
        footnotes: {
          errors: [
            {
              carrierCode: "91",
              tarriffCode: "TAFP",
              footnote: "V",
              lineNum: "4",
              message:
                "Effective date must be greater than today for non-EDOT tarrif TAFP at row 000000004",
              timestamp: "2019-08-01 23:30:59.371",
            },
          ],
          warnings: [
            {
              carrierCode: "91",
              tarriffCode: "TAFP",
              footnote: "",
              lineNum: "1",
              message: "Invalid Number of Records In The Work Unit Of 00005",
              timestamp: "2019-08-01 23:30:57.141",
            },
          ],
        },
        rules: {
          msg: "There are more than 400 errors/warnings. Please log into Upload Transmission Job Status Display to view the additional errors/warnings.",
          errors: [
            {
              carrierCode: "91",
              lineNum: "4",
              message: "INVALID PASSENGER TYPE CODE OF XXX",
              rule: "1000",
              tarriffCode: "IPRA",
              timestamp: "2019-12-18 14:51:07.104",
            },
          ],
        },
        fares: {
          errors: [
            {
              carrierCode: "91",
              tarriffCode: "TAFP",
              fareKey: "F-81 10089-NYC-PAR-CBS3-N--0-USD-2019-12-12",
              message:
                "Effective date must be greater than today for non-EDOT tarrif TAFP at row 000000004",
              timestamp: "2019-08-01 23:30:59.371",
            },
          ],
          warnings: [
            {
              carrierCode: "91",
              tarriffCode: "TAFP",
              fareKey: "F-81 10089-NYC-PAR-CBS3-N--0-USD-2019-12-12",
              message: "Invalid Number of Records In The Work Unit Of 00005",
              timestamp: "2019-08-01 23:30:57.141",
            },
          ],
        },
      },
    },
  ],
}

Request to Retrieve Partner Work Units

(with workUnitName, createDate, and partnerOrgCode parameter specified in the request)

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?workUnitName=test&partnerOrgCode=91&createDate=12MAR21

Response

{
  totalWorkUnits: 2,
  workUnitName: "TEST",
  createDate: "12MAR21",
  partnerOrgCode: "91",
  retrieveFilingErrors: "Y",
  retrieveJustifications: "N",
  workUnits: [
    {
      workUnitId: "91-12MAR21-2",
      workUnitName: "TEST",
      workUnitStatus: "Incomplete w/Errors",
      exclusiveAccess: "N",
      distributedTime: "9999-12-31 00:00:00.0",
      description: "",
      contents: [
        {
          carrier: "91",
          global: "AT",
          tariff: "IPRA",
          batchType: "Rules",
          batchID: "9100673",
          validationLevel: "Full",
          recordCount: 0,
        },
        {
          carrier: "91",
          global: "AT",
          tariff: "IPRA",
          batchType: "Rules",
          batchID: "9113358",
          validationLevel: "Limited",
          recordCount: 0,
        },
      ],
      msgs: [
        {
          level: "WU RELEASE ERROR",
          details: [
            {
              message: "Following Batch(es) did not complete successfully",
              subDetails: [
                "Carrier:91,Tariff:IPRA,Batch Id:91 13358,Batch Type:Rules",
                "Carrier:91,Tariff:IPRA,Batch Id:91 673,Batch Type:Rules",
              ],
            },
          ],
        },
      ],
    },
    {
      workUnitId: "91-12MAR21-1",
      workUnitName: "TEST",
      workUnitStatus: "Incomplete",
      exclusiveAccess: "N",
      distributedTime: "9999-12-31 00:00:00.0",
      description: "",
      contents: [
        {
          carrier: "91",
          global: "AT",
          tariff: "IPRA",
          batchType: "Rules",
          batchID: "9113303",
          validationLevel: "Limited",
          recordCount: 0,
        },
      ],
    },
  ],
}

Request to Retrieve Partner Work Units

(with workUnitId parameter specified in the request)

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?workUnitId=91-03APR21-1

Response

{
  totalWorkUnits: 1,
  workUnitId: "91-03APR21-1",
  retrieveFilingErrors: "Y",
  retrieveJustifications: "N",
  retrieveUploadErrors: "N",
  afterTimestamp: "",
  workUnits: [
    {
      workUnitId: "91-03APR21-1",
      workUnitName: "REAS",
      workUnitStatus: "Incomplete",
      exclusiveAccess: "N",
      distributedTime: "9999-12-31 00:00:00.0",
      description: "FARES",
      contents: [
        {
          carrier: "91",
          global: "CA",
          tariff: "CF1",
          batchType: "Fares",
          batchID: "9115458",
          validationLevel: "Full",
          recordCount: 0,
        },
      ],
    },
  ],
}

Request with Work Unit ID and Retrieve Justification Parameter Specified

Request

GET https://developer.atpco.net/services/gtst/v1/distribution/wusummary/workunit?workUnitId=ATP-14MAR19-14&retrieveFilingErrors=N&retrieveJustifications=Y

Below is an example of the workUnitProgress value returned in the Retrieve Work Unit Summary API response when the work unit status is “Queued.”

Response

{
  "retrieveFilingErrors": "N",
  "retrieveJustifications": "Y",
  "totalWorkUnits": 1,
  "workUnitId": "ATP-02SEP26-22",
  "workUnits": [
    {
      "workUnitId": "ATP-02SEP26-22",
      "workUnitName": "TEST",
      "workUnitStatus": "Queued",
      "exclusiveAccess": "Y",
      "distributedTime": "2026-09-02 00:04:06.315495",
      "description": "",
      "contents": [
        {
          "batchID": "8118625",
          "batchType": "Fares",
          "carrier": "91",
          "fanNumber": "02SEP26-AAG",
          "global": "AT",
          "recordCount": 1,
          "tariff": "AUSA",
          "validationLevel": "Full"
        }
      ],
      "justifications": [
        {
          "carrier": "91",
          "effectiveDate": "",
          "govemment": "DE",
          "justificationText": "ADDING FARES TO REMAIN COMPETITIVE",
          "tariff": "AUSA",
          "workUnitProgress": "5.0%"
        }
      ]
    }
  ]
}

GOLD Environment Endpoint

Work Unit Summary - https://gold.apis.atpco.net/wusummary-gold/rest/dds/v1/distribution/wusummary/workunit