Logistics API

CHGMessageCHGExceptionMessage

$typestringrequired

Allowed values:CHG.iCLASSFW.Base.Foundation.CHGExceptionMessage, CHG.iCLASSFW.Base.Foundation

_additionalInfosnull | string
_messageLogIdnull | string
_messageTypeintegerrequired
_traceIdnull | string
additionalInfosnull | string
errorCategorynull | string
errorCodeinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

formatArgumentsnull | array
messagenull | string
messageKeyinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

messageLogIdnull | string
sourcenull | string
sourceObjectIdentifierobject
Show Child Parameters
traceIdnull | string
Example

CHGMessageExternalMessage

$typestringrequired

Allowed values:CHG.iCLASSFW.Base.Foundation.ExternalMessage, CHG.iCLASSFW.Base.Foundation

_additionalInfosnull | string
_messagenull | string
_messageLogIdnull | string
_messageTypeintegerrequired
_traceIdnull | string
errorCategorynull | string
errorCodeinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

formatArgumentsnull | array
messageKeyinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

messageLogIdnull | string
sourcenull | string
sourceObjectIdentifierobject
Show Child Parameters
traceIdnull | string
Example

CHGMessageTextMessage

$typestringrequired

Allowed values:CHG.iCLASSFW.Base.Foundation.TextMessage, CHG.iCLASSFW.Base.Foundation

_additionalInfosnull | string
_messagenull | string
_messageLogIdnull | string
_messageTypeintegerrequired
_traceIdnull | string
errorCategorynull | string
errorCodeinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

formatArgumentsnull | array
messageKeyinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

messageLogIdnull | string
sourcenull | string
sourceObjectIdentifierobject
Show Child Parameters
traceIdnull | string
Example

CHGRecurrenceInfo

object
_changedPropertiesnull | object
_changedPropertyNamesnull | array[string]
_internalReferenceIDnull | string
additionalPropertiesnull | object
allDayboolean
cronExpressionnull | string
dataStateinteger
dayNumberinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

endDatestring(date-time)
monthinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

periodicityinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

recurrenceCountinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

recurrenceRangeinteger
startDatestring(date-time)
typeinteger
weekDaysinteger
weekOfMonthinteger
Example

CHGRecurrenceRange

integer