agreementtmfwebservices API

basic

extended

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

agreementAuthorization
optional

< AgreementAuthorization > array

agreementItem
optional

< AgreementItem > array

agreementPeriod
optional

The time period during which the Agreement is in effect.

TimePeriod

agreementSpecification
optional

AgreementSpecificationRef

agreementType
optional

The type of the agreement. For example commercial

string

associatedAgreement
optional

< AgreementRef > array

characteristic
optional

< Characteristic > array

completionDate
optional

Date at which the agreement is completed

TimePeriod

description
optional

Narrative that explains the agreement and details about the it , such as why the agreement is taking place.

string

documentNumber
optional

A reference number assigned to an Agreement that follows a prescribed numbering system.

integer(int32)

engagedParty
optional

< RelatedParty > array

href
optional

Unique url identifying the agreement as a resource

string

id
optional

Unique identifier for the agreement

string

initialDate
optional

Date at which the agreement was initialized

string(date-time)

name
required

A human-readable name for the agreement

string

statementOfIntent
optional

An overview and goals of the Agreement

string

status
optional

The current status of the agreement. Typical values are: in process, approved and rejected

string

version
optional

A string identifying the version of the agreement

string

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementAttributeValueChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

fieldPath
optional

The path identifying the object field concerned by this notification.

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreement
optional

The involved resource data for the event

Agreement

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

date
optional

The date associated with the authorization state.

string(date-time)

signatureRepresentation
optional

Indication that represents whether the signature is a physical paper signature or a digital signature.

string

state
optional

Current status of the authorization, for example in process, approved, rejected.

string

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementCreateEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreement
optional

The involved resource data for the event

Agreement

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementDeleteEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreement
optional

The involved resource data for the event

Agreement

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

product
optional

The list of products indirectly referred by this agreement item (since an agreement item refers primarily to product offerings)

< ProductRef > array

productOffering
optional

The list of product offerings referred by this agreement item

< ProductOfferingRef > array

termOrCondition
optional

< AgreementTermOrCondition > array

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the agreement

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

configurable
optional

If true, the Boolean indicates that the characteristic is configurable

boolean

description
optional

A narrative that explains in detail what the characteristic is

string

name
optional

Name of the characteristic being specified.

string

specCharacteristicValue
optional

< AgreementSpecCharacteristicValue > array

validFor
optional

The period for which the specification characteristic is valid

TimePeriod

valueType
optional

A kind of value that the characteristic can take on, such as numeric, text and so forth

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

default
optional

Indicates if the value is the default value for a characteristic

boolean

unitOfMeasure
optional

Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on.

string

validFor
optional

The period of time for which a value is applicable

TimePeriod

value
optional

A discrete value that the characteristic can take on

object

valueFrom
optional

The low range value that a characteristic can take on

string

valueTo
optional

The upper range value that a characteristic can take on

string

valueType
optional

A kind of value that the characteristic can take on, such as numeric, text, and so forth

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachment
optional

< AttachmentRefOrValue > array

description
optional

A narrative that explains in detail what the agreement specification is about

string

href
optional

Reference of the agreement specification

string

id
optional

Unique identifier of the agreement specification

string

isBundle
optional

If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property

boolean

lastUpdate
optional

Date and time of the last update

string(date-time)

lifecycleStatus
optional

Indicates the current lifecycle status

string

name
optional

Name of the agreement specification

string

relatedParty
optional

< RelatedParty > array

serviceCategory
optional

CategoryRef

specificationCharacteristic
optional

< AgreementSpecCharacteristic > array

specificationRelationship
optional

< AgreementSpecificationRelationship > array

validFor
optional

The period for which the agreement specification is valid

TimePeriod

version
optional

Agreement specification version

string

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementSpecificationAttributeValueChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

fieldPath
optional

The path identifying the object field concerned by this notification.

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreementSpecification
optional

The involved resource data for the event

AgreementSpecification

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementSpecificationCreateEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreementSpecification
optional

The involved resource data for the event

AgreementSpecification

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementSpecificationDeleteEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreementSpecification
optional

The involved resource data for the event

AgreementSpecification

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

description
optional

A narrative that explains in detail what the agreement specification is about.

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the agreement specification

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
optional

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

relationshipType
optional

Type of relationship such as, substitution or dependency.

string

validFor
optional

The period for which the relationship is valid

TimePeriod

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementSpecificationStateChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreementSpecification
optional

The involved resource data for the event

AgreementSpecification

correlationId
optional

The correlation id for this event.

string

description
optional

An explanatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

AgreementStateChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the resource involved in the event

string

id
optional

Identifier of the resource involved in the event

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

agreement
optional

The involved resource data for the event

Agreement

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

description
optional

Text that explains the term or condition of the agreement.

string

id
optional

Unique number assigned for reference.

string

validFor
optional

The period of time during which the term or condition of the agreement applies.

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachmentType
optional

Attachment type such as video, picture

string

content
optional

The actual contents of the attachment object, if embedded, encoded as base64

string

description
optional

A narrative text describing the content of the attachment

string

href
optional

URI for this Attachment

string

id
optional

Unique identifier for this particular attachment

string

mimeType
optional

Attachment mime type such as extension file for video, picture and document

string

name
optional

The name of the attachment

string

size
optional

The size of the attachment.

Quantity

url
optional

Uniform Resource Locator, is a web page address (a subset of URI)

string

validFor
optional

The period of time for which the attachment is valid

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

version
optional

Category version

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

name
required

Name of the characteristic

string

value
required

The value of the characteristic

AgreementSpecCharacteristicValue

valueType
optional

Data type of the value of the characteristic

string

@baseType
optional

When sub-classing, this defines the super-class.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name.

string

code
required

Application relevant detail, defined in the API or a common list.

string

message
optional

More details and corrective actions related to the error which can be shown to a client user.

string

reason
optional

Explanation of the reason for the error which can be shown to a client user.

string

referenceError
optional

URI of documentation describing the error.

string

status
optional

HTTP Error code extension

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

amount
optional

Numeric value in a given unit

number(float)

units
optional

Unit

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
required

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
required

Name of the related entity.

string

role
optional

Role played by the related party

string

endDateTime
optional

End of the time period, using IETC-RFC-3339 format

string(date-time)

startDateTime
optional

Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end

string(date-time)