Release Work Unit Web Service
Use the Release Work Unit Web Service to release, test release, or schedule the release of eligible work units, thereby completing the filing workflow and distributing data to the marketplace.
Request
Your request to the Release Work Unit 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 must include the following parameters:
- Work Unit IDs - up to ten (1-10) Work Unit IDs
- Release Type - Release, Test Release, Scheduled for Release
- Schedule for Release Date - required when Release Type is Scheduled for Release
Users can also release their partner work units by specifying the partner Work Unit ID in the request. If the non-owning work unit carrier actor has no data (batch data or DDC), and no batch, and no Tier 2 access with the work unit owner, the actor cannot view or take any actions against that work unit. Users must have Tier 2 Partner Access Control Release Authority from the work unit owner for release of a non-owned work unit.
Requests can optionally include the following parameter:
Ignore Fares Error - "Y"/"N" indicator used to determine whether the work unit is to be released when fares errors are found. The default is "Y", indicating that the work unit release process will continue when fares errors are found.
Upon successful processing of the request, the release of the work units will be initiated.
Request Header Parameters
See Authentication for full instructions on header parameters needed for authentication.
Request Body
The request body should be formatted as a JSON object, which must include the required parameters and can additionally include the optional parameter.
Request Object Parameters
The request object can include any of the following optional parameters:
| Parameter | Description | Type | Format | Example |
|---|---|---|---|---|
releaseType* | Determines the type of release to perform on the Work Unit(s) | String | "R": the Work Unit release process will commence immediately; "T": the Work Unit will go through Test Release; "S": the Work Unit will be scheduled for release at a future date and time | "S" |
scheduledReleaseDate | Required when releaseType is "S". Determines when the work unit processing should commence | String | Alphanumeric date and time up to 7 days from the current date: DDMMMYY hhmm | "17MAR18 2218" |
workUnitIds* | Comma-separated list of unique identifiers assigned to Work Units | String | Alphanumeric between 10-17 characters, including (in order) 1) the 2-3 character org code (XXX), 2) the create date, and 3) the work unit number: XXX-DDMMMYY-NNNNNNN - when multiple Work Unit IDs are specified, they must be comma separated | "XXX-17MAR18-1234567" |
ignoreFareError | Determines whether the Work Unit(s) is/are to be released when fares errors (validate/apply) are found (Default is "Y") | String | "Y" ignore error and continue processing; "N" do not release Work Unit(s) if batch errors are found | "N" |
*required parameter
Response
The response can include the following details:
Response Parameters
| Parameter | Description | Type | Example |
|---|---|---|---|
details | Collection of release messages for one or more Work Units | Array | [ "Release successfully submitted" ] |
ignoreFareError | When included in the request. Indicates whether the Work Unit(s) is/are to be released when fares errors (validate/apply) are found (Default is "Y") | String | "N" |
level | Indicates whether a message is "ERROR" or "INFO" | String | "INFO" |
msg | Top-level message | String | "Submit request was successful" |
msgs | Collection of messages | Array | [ { "workUnitId": "91-28JUL18-31", "msgList": [ { "level": "INFO", "details": [ "Release successfully submitted" ] } ] } ] |
msgList | Grouping of work unit release messages for one or more Work Units | Array | [ { "level": "INFO", "details": [ "Release successfully submitted" ] } ] |
releaseType | The type of release to be performed on the Work Unit(s) | String | "S" |
scheduledReleaseDate | Required when releaseType is "S". When the work unit processing should commence | String | "17MAR18 2218" |
workUnitIds | Comma-separated list of unique identifiers assigned to Work Units | String | "XXX-17MAR18-1234567" |
Example Requests and Responses
The following examples show what the Release Work Unit Web Service would return based on the indicated requests.
Request Release of a Single Work Unit when Ignore Fare Errors Indicator is Set to "N"
"N"Request
Response
Request with Test Release for Multiple Work Units
Request
Response
Request with Scheduled for Release for a Work Unit
Request
Response
Request to Release Partner Work Unit by Organization 91
Request
Response