General properties

The main characteristics of the orderStructure are the presence of the order entity, which groups general information about an order or task for, for example, inspection, appraisal or repair of damage. Therefore, claim and claim-related entities often occur within the orderStructure, but this is not mandatory.

Mandatory components

The table below contains all mandatory entities and attributes of the orderStructure. Please note: these are only the mandatory components; in this case only the presence of an order. In many functions and messages, the message will be more extensive, including claim and incident entities, and often a commonFunctional entity for meta-data. See later in this section for a more detailed example.

Name Occur. Type Description
orderStructure 1..1 entity Structure of order related data, based on AFD attributes.
order 1..1 entity The main entity of the order structure.
entityType 1..1 string Set to ‘default’.

JSON example

Below is an example of an orderStructure, including details about the corresponding order. Note that at the top level within JSON, the orderStructure entity is not explicitly mentioned. When the orderStructure is nested within other structures, the orderStructure is given an explicit tag. In XML, the structure is always explicitly defined at the highest level as well.

{
	"commonFunctional": [ {
		"entityType": "default",
		"functionVariant": "update",
		"dataCatalogVersion": "34C"
	} ],
	"order": [ { 
		"entityType": "default",
		"desiredExecutionDate": "2020-03-01",
		"party": [ {
			"entityType": "principal",
			"porCompany": "A754"
		},
		{
			"entityType": "contractor",
			"firstName": "Bert",
			"surname": "Nieuwkoop"
		} ]
	} ]
}

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment