Event metadata

This endpoint is used to return all the available fields and their relevant metadata for the event screen.

get

https://api.claimsmanagertest.crawco.co.uk/metadata/events

Path parameters

Parameters marked are required.
Parameter Name	Description	Type	Example Data
`incidentId`	The id for the incident you want to add an event to	integer	6597925
`eventType`	The type of event you want to add. One of Event Log Entry, Reminder or Correspondence Entry	string	Event Log Entry

The type of event will determine which fields are available, some fields will be available on multiple event types, and some will only relate to a specific type. To be certain that the field you want to add data to is available for your intended event type, be sure to call this endpoint with the relevant event type first.

Example request

curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/metadata/Events?incidentId=6597925&eventType=Event%20Log%20Entry' \
--header 'Authorization: Bearer {access token}'

Response body parameters

Parameter Name	Description	Type	Example Data
`identifier`	Unique identifier for the field. When the mapsTo property is ‘extendedFields’, this should be populated in the identifier field of the extendedField.	string	Global_Incident_Form:File_Handler
`mapsTo`	Determines which property in the relevant model the field should be populated in. When this is ‘extendedFields’, the field should be added to the extendedFields array with the given identifier.	string	extendedFields
`name`	The name of the field as it appears in Claims Manager	string	File Handler
`section`	The tab in which this field can be found in Claims Manager	string	Status
`dataType`	The expected data type for the field. When the mapsTo property is extendedFields, the given string value of the extendedField should be convertible to this data type.	string	string
`maxLength`	When the dataType property is string, this field is the maximum length string that will be accepted.	numeric	100
`isRequired`	Flag showing whether the field is marked as required in Claims Manager.	boolean	True
`listSource`	When present, indicates that the value of this field should be one of the given options in the array.	array (string)	[“Option 1”, “Option 2”]

Example response

[
    {
        "identifier": "Global_Event_Form:Class",
        "mapsTo": "eventType",
        "name": "Type",
        "section": null,
        "dataType": "string",
        "maxLength": 50,
        "isRequired": true,
        "listSource": [
            "Correspondence Entry",
            "Event Log Entry",
            "Reminder"
        ]
    },
    {
        "identifier": "Global_Event_Form:EventLog.Category",
        "mapsTo": "category",
        "name": "Category",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": true,
        "listSource": [
            "Intervention Comments",
            "Request Submission",
            "Request Submission Rejected Documents",
            "Current Status",
            "Report: Large Loss Report",
            "Report: Preliminary",
            "Report: Final",
            "Letter",
            "Statement",
            "Photographs",
            "Other",
            "Loss Adjusting assignment",
            "WeGoLook assignment",
            "Contractor Connection assignment"
        ]
    },
    {
        "identifier": "Global_Event_Form:Detail",
        "mapsTo": "detail",
        "name": "Detail",
        "section": null,
        "dataType": "string",
        "maxLength": -1,
        "isRequired": true,
        "listSource": null
    }
]