common-objects.adoc

Common objects

Definitions for objects used in multiple SHIP message types.

timeSpan object

A time period with a start time

Table 1. Fields of the timeSpan object

Name	Type	Usage	Description	Example
startTime	ISO8601 date-time string	REQUIRED	Start time	"2016-07-22T00:00:00.000-07:00"
timeUnits	integral number	REQUIRED	Number of time units	2
timeUnitType	string enum: DAY, HOUR, MINUTE	REQUIRED	Type of the time units	"DAY"

monetaryValue object

A monetary value consisting of a number and a currency

Table 2. Fields of the monetaryValue object

Name	Type	Usage	Description	Example
value	decimal number	REQUIRED	Number of units of the currency	19.95
currency	string	RECOMMENDED	ISO4217 3-character currency code	"USD"

monetaryAmount object

An amount of money with associated tax

Table 3. Fields of the monetaryAmount object

Name	Type	Usage	Description	Example
amountBeforeTax	monetaryValue object	RECOMMENDED	Amount before tax
taxAmount	monetaryValue object	RECOMMENDED	Tax amount
value	decimal number	DEPRECATED	Number of units of the currency of the pre-tax amount. Use amountBeforeTax instead.	19.95
currency	string	DEPRECATED	ISO4217 3-character currency code of the pre-tax amount. Use amountBeforeTax instead.	"USD"

companyInfo object

A minimal set of information about a company

Table 4. Fields of the companyInfo object

Name	Type	Usage	Description	Example
name	string	REQUIRED	Name of the company	"AVERTINE"

guestNote object

A note

Table 5. Fields of the guestNote object

Name	Type	Usage	Description	Example
title	string	OPTIONAL	Note title	"Background note"
text	string	REQUIRED	Note text	"Background note text"
type	string	OPTIONAL	Note type	"Background notes"
time	ISO8601 date-time string	OPTIONAL	Time the note was created/updated	"2016-07-14T20:52:01.132Z"

userDefinedField object

A name-value pair defined by a specific system or application

Table 6. Fields of the userDefinedField object

Name	Type	Usage	Description	Example
name	string	REQUIRED	Field name. If two fields have the same name, their values form an unordered list.	"UDF01"
value	string	REQUIRED	Field value	"Opaque value"

summary object

A Summary of the SHIP objects list result.

Table 7. Fields of the summary object

Name	Type	Usage	Description	Example
successCount	integer	REQUIRED	Number of SHIP objects successfully processed	6
errorCount	integer	REQUIRED	Number of SHIP objects that failed to process	7
totalCount	integer	REQUIRED	Total number of SHIP objects processed	13