Incident metadata

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

Path parameters

Parameters marked are required.

Parameter Name	Description	Type	Example Data
programmeCode	Programme code	string	8ffd4f55
policyTypeCode	Policy type code	string	17ed9895
countryCode	Policy country code. ISO 2-character code	string	GB
incidentDate	The date of the incident. When omitted this defaults to the current date	string($date)	2022-04-30

Example request

curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/metadata/parties?programmeCode=8ffd4f55&policyTypeCode=17ed9895&countryCode=GB' \
--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_Party_Form:Party_Type",
        "mapsTo": "partyType",
        "name": "Party Type",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": true,
        "listSource": [
            "Third Party",
            "Witness",
            "Claimant Lawyer",
            "Own Lawyer",
            "Expert",
            "Insurer",
            "Insured",
            "Reporting Party",
            "Police",
            "Other"
        ]
    },
    {
        "identifier": "Global_Party_Form:Other_Party_Type",
        "mapsTo": "extendedFields",
        "name": "Other Party Type",
        "section": null,
        "dataType": "string",
        "maxLength": 100,
        "isRequired": true,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Claimants",
        "mapsTo": "linkedClaimants",
        "name": "Claimant(s)",
        "section": null,
        "dataType": "string",
        "maxLength": 4000,
        "isRequired": false,
        "listSource": []
    },
    {
        "identifier": "Global_Party_Form:Party_Name",
        "mapsTo": "name",
        "name": "Party Name",
        "section": null,
        "dataType": "string",
        "maxLength": 100,
        "isRequired": true,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Organisation",
        "mapsTo": "isOrganisation",
        "name": "Party Is Organisation",
        "section": null,
        "dataType": "boolean",
        "maxLength": null,
        "isRequired": true,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:ContactPerson2",
        "mapsTo": "extendedFields",
        "name": "Contact Person",
        "section": null,
        "dataType": "string",
        "maxLength": 250,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Gender",
        "mapsTo": "gender",
        "name": "Gender",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Male",
            "Female"
        ]
    },
    {
        "identifier": "Global_Party_Form:DOB",
        "mapsTo": "dateOfBirth",
        "name": "Date of Birth",
        "section": null,
        "dataType": "string($date)",
        "maxLength": null,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Reference",
        "mapsTo": "reference",
        "name": "Reference",
        "section": null,
        "dataType": "string",
        "maxLength": 35,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Incident_Form:Party_VehicleRegistration",
        "mapsTo": "extendedFields",
        "name": "Vehicle Registration",
        "section": null,
        "dataType": "string",
        "maxLength": 50,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Address",
        "mapsTo": "address",
        "name": "Address",
        "section": null,
        "dataType": "string",
        "maxLength": 250,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Party_Postcode",
        "mapsTo": "postCode",
        "name": "Postcode",
        "section": null,
        "dataType": "string",
        "maxLength": 35,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Telephone_Number",
        "mapsTo": "telephoneNumber",
        "name": "Telephone Number",
        "section": null,
        "dataType": "string",
        "maxLength": 50,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Email_Address",
        "mapsTo": "emailAddress",
        "name": "Email Address",
        "section": null,
        "dataType": "string($email)",
        "maxLength": 100,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Mobile_Telephone_No",
        "mapsTo": "extendedFields",
        "name": "Mobile Number",
        "section": null,
        "dataType": "string",
        "maxLength": 50,
        "isRequired": false,
        "listSource": null
    },
    {
        "identifier": "Global_Party_Form:Email_Preference",
        "mapsTo": "extendedFields",
        "name": "Communication preference: Email",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Allowed",
            "Preferred",
            "Prohibited"
        ]
    },
    {
        "identifier": "Global_Party_Form:Letter_Preference",
        "mapsTo": "extendedFields",
        "name": "Communication preference: Letter",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Allowed",
            "Preferred",
            "Prohibited"
        ]
    },
    {
        "identifier": "Global_Party_Form:Mobile_Telephone_Preference",
        "mapsTo": "extendedFields",
        "name": "Communication preference: Mobile Telephone",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Allowed",
            "Preferred",
            "Prohibited"
        ]
    },
    {
        "identifier": "Global_Party_Form:SMS_Preference",
        "mapsTo": "extendedFields",
        "name": "Communication preference: SMS",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Allowed",
            "Preferred",
            "Prohibited"
        ]
    },
    {
        "identifier": "Global_Party_Form:Telephone_Preference",
        "mapsTo": "extendedFields",
        "name": "Communication preference: Telephone",
        "section": null,
        "dataType": "string",
        "maxLength": 10,
        "isRequired": false,
        "listSource": [
            "Allowed",
            "Preferred",
            "Prohibited"
        ]
    }
]