Miscellaneous Provisions(Category 23) Rules Web Service

Miscellaneous Provisions (Category 23) Rules API is used to express conditions that restrict the use of the fare specifically for construction, differential processing and proration. The API is designed by ATPCO to meet your needs for automated table creation so you can reduce manual input and get your fares to market faster.

Request

Your request to the Miscellaneous Provisions (Category 23) Rules Web Service must provide a valid OAuth Access Token. For instructions on how to obtain and use an OAuth Access Token programmatically, see OAuth Access Tokens and Authentication. You must also specify parameters in the request body.

Request Header Parameters

See OAuth Access Tokens and Authentication for instructions on header parameters needed for authentication.

Request Body

The request body should be formatted as a JSON object (examples below).

Request Object Parameters

All data requests must be received in the JSON format specified by ATPCO, with field names and sub values found in Data Application unless otherwise specified (fields and sub values (i.e., parameters) detailed below). Field names and provided values must be enclosed in quotation marks (e.g., "tvlDtExp").

"" or " " as a field name or field value: an empty or non-empty blank string within quotation marks in the request is ignored and will not appear in the JSON response
Invalid field names in a request are ignored
Invalid field values in a request generate an error

If your request contains field names that are invalid in a request yet valid in a response (e.g., msgs or msg), those fields will be eliminated during processing and overlaid when necessary in the response.

All String fields (enclosed in double quotes) will have leading and trailing spaces removed unless removing all blanks would violate a possible value for a field where blank(s) is valid on a JSON request. Some fields may have special leading/trailing blanks removal rules such as NoteText996, where only trailing blanks are removed to preserve any intentional text indentations.

Field name	Value	Issue	System Handling
`" tvlDtExp"`		Extra leading space	ignored
`"tvlDtExp "`		Extra trailing space	ignored
`"tvlDExp"`		Field name incorrect. Missing 't'	ignored
	`" WAS"`	Extra leading space	Error invalid city format

Examples of Invalid Field names and values

The request object can include any of the following parameters:

Category 23 Parameters

Field name	Description	Type	Format	Example
`miscprovision23`	Wrapper for Category 23 domain	Collection of key-value pairs		`{ }`
`addonCons`	A code indicating if the fare can be used for construction of published fares.	String (max 1-character)	`"Y"` = The fare may be used for add-on conctruction; `"N"` = The fare may not be used for add-on construction ; `"R"` = The fare must only be used for add-on constructionand should not be displayed or sold in its specified fare market
`prorate`	An indicator specifying if the fares must be used for prorate calculation.	String (max 1-character)	`"N"` = The fare may not be used for proration ; `"R"` = The fare must only be used for proration and not available for fare display
`diffCalc`	An indicator specifying if the fare class/fare type is to be used for differential calculation for mixed class travel.	String (max 1-character)	`"N"` = The fare must not be used as the high or low fare when creating a differential. The fare maybe used as the through fare when pricing a fare component with or withot a differential. ; `"R"` = The fare must not be used as the high or low fare when creating a differential. The fare must mot be used as a through fare when pricing a fare component with or without a differential.
`extensionFares`	An indicator specifying the fare is an extension fare.	String (max 1-character)	`"P"` = The fare may only be used for extension fares and should not be displayed in its specified market.

994 Override Date Fields

Field name	Description	Type	Format	Example
`ovrrdDt994`	Wrapper for 994 Subdomain	Collection of key-value pairs		`{ }`
`tvlEff`	The first date travel is valid for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`
`tvlDisc`	The last date travel is valid for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`
`tktEff`	The first date ticketing is valid for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`
`tktDisc`	The last date ticketing is valid for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`
`rsvEff`	The first date reservations can be made for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`
`rsvDisc`	The last date reservations can be made for the Category Record 3 provisions	String	YYYYMMDD	`"20180930"`

996 Note Text

Field name	Description	Type	Format	Example
`noteTxt996`	Wrapper for 996 Table	Collection of key-value pairs		`{ }`
`txtLns`	Collection of lines of free-form text specified in the request	Array of collections of key-value pairs		`[ { "lnNum": "1", "txt": "THIS IS SAMPLE NOTE TEXT" }, ... ]`
`lnNum`	Line number indicating the placement of the associated `txt` field	String	#	`"1"`
`txt`	The text to be printed at the corresponding `lnNum` (line number)	String	Free-form text	`"THIS IS SAMPLE NOTE TEXT"`

General Fields

Field name	Description	Type	Format	Example
`rtnTblNumsOnly`	Indicates whether to display the created table numbers and the data values specified in the Request. When set to `"Y"` (True), ONLY the table numbers will display in the Response. Default is `"N"` (False).	String (max 1-character)	`"Y"` = True; `"N"` = False	`"N"`
`tblNum`	Indicates an existing 900 series table in a request or generated in a response when data has been created	String	#####	`"4035046"`

Response

Responses from the Miscellaneous Provisions (Category 23) Rules Web Service use the same parameters as requests, outlined above. Responses can also include msg and msgs, which are used to communicate error messages.

Example Requests and Responses

Simple Category Request

(display only table numbers in response)

request response

Copy

Copied

{
  "rtnTblNumsOnly":"Y",

  "miscprovision23": {
    "addonCons": "Y",
	"prorate": "R",
	"diffCalc": "N",
	"extensionFares": "P"
  }
}

Copy

Copied

{
  "rtnTblNumsOnly": "Y",
  "miscprovision23": {
    "tblNum": "4035046"
  }
}

Simple Category Request with Supporting Table 994

(display table numbers and values in response)

request response

Copy

Copied

{
  "rtnTblNumsOnly":"N",

  "miscprovision23": {
    "addonCons": "Y",
	"prorate": "R",
	"diffCalc": "N",
	"extensionFares": "P",
    "ovrrdDt994": {
      "rsvEff": "20180101"
    }
  }
}

Copy

Copied

{
  "rtnTblNumsOnly": "N",
  "miscprovision23": {
    "tblNum": "4034902",
    "addonCons": "Y",
	"prorate": "R",
	"diffCalc": "N",
	"extensionFares": "P",
    "ovrrdDt994": {
      "tblNum": "58696",
      "rsvEff": "20180101"
    }
  }
}

Full Category Request

(display only table numbers in response)

request response

Copy

Copied

{
  "rtnTblNumsOnly":"Y",


  "miscprovision23": {
    "addonCons": "Y",
    "prorate": "X",
	"diffCalc": "N",
	"extensionFares": "P",
    "ovrrdDt994": {
      "rsvEff": "20180101",
      "rsvDisc": "20180731",  
      "tktDisc": "20180731",
      "tvlEff": "20180201",
      "tvlDisc": "20180930"
    },
    "noteTxt996": {
      "txtLns": [{"lnNum":"1","txt": "THIS IS SAMPLE NOTE TEXT TO ILLUSTRATE"}
                ,{"lnNum":"2","txt": "          INDENTATION AND LINE BREAKS"}
                ,{"lnNum":"3","txt": "                IN YOUR REQUEST AND RESPONSE."}
                ,{"lnNum":"4","txt": "WE HOPE THAT YOU ARE ENJOYING OUR DEMO.."}]
    }
  }
}

Copy

Copied

{
  "rtnTblNumsOnly": "Y",

  "miscprovision23": {
    "tblNum": "4035073",
    "ovrrdDt994": {
      "tblNum": "58746"
    },
    "noteTxt996": {
      "tblNum": "8187666"
    }
  }
}

Simple Category Request

(display request values in response)

request response

Copy

Copied

{
  "rtnTblNumsOnly":"N",

  "miscprovision23": {
    "addonCons": "Y",
	"prorate": "R",
	"diffCalc": "N",
	"extensionFares": "P"
  }
}

Copy

Copied

{
  "rtnTblNumsOnly": "N",
  "miscprovision23": {
    "tblNum": "4035046",
    "addonCons": "Y",
	"prorate": "R",
	"diffCalc": "N",
	"extensionFares": "P"
  }
}

Simple Category Request Using Data and Existing 994 Table Number

(display table number and values in response)

request response

Copy

Copied

{
  "rtnTblNumsOnly":"N",
  "miscprovision23": {
    "addonCons": "Y",
    "ovrrdDt994": {
      "tblNum": "12345678",
    }
  }
}

Copy

Copied

{
  "rtnTblNumsOnly": "N",
  "miscprovision23": {
    "tblNum": "4034902",
    "addonCons": "Y",
    "ovrrdDt994": {
      "tblNum": "12345678",
		
    }
  }
}