Party lookup
This endpoint is used to return all the fields from the Party screen and their current values for a given party id.
get
https://api.claimsmanagertest.crawco.co.uk/incidents/{incidentId}/parties/{partyId}
Path parameters
Parameters marked are required.
Parameter Name |
Description |
Type |
Example Data |
incidentId
|
The incident id of the incident |
Integer |
6597925 |
partyId
|
The party id of the party |
Integer |
288842 |
Example request
curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/incidents/6597925/parties/288842' \
--header 'Authorization: Bearer {access token}'
Response body parameters
Parameter Name |
Description |
Type |
Example Data |
partyType
|
The type of the party. |
string |
Witness |
name
|
The name of the party. |
string |
Smith |
isOrganisation
|
Flag specifying whether the party is an individual or an organisation. |
Boolean |
False |
gender
|
The gender of the party. |
string |
Male |
dateOfBirth
|
The date of birth of the party. |
string ($date) |
1984-01-16 |
reference
|
A reference to identify the party |
string |
MC153536 |
address
|
Address of the party. |
string |
54 Courtlands Drive
Epsom
Surrey
|
postcode
|
Post code of the party. |
string |
KT19 0AA |
telephoneNumber
|
The telephone number of the party. |
string |
0208 364 5283 |
emailAddress
|
The email address of the party. |
string($email) |
dennis.mccarthy@email.com |
linkedClaimants
|
Where the party is related to a claimant, this field should contain the name of relevant claimant |
string |
John Smith |
extendedFields
|
An array containing any extended fields |
array |
|
Example response
{
"partyType": "Witness",
"name": "Dennis McCarthy",
"isOrganisation": false,
"gender": "Male",
"dateOfBirth": "1984-01-16",
"reference": "MC153536",
"address": "54 Courtlands Drive\r\nEpsom\r\nSurrey",
"postCode": "KT19 0AA",
"telephoneNumber": "0208 364 5283",
"emailAddress": "dennis.mccarthy@email.com",
"linkedClaimants": null,
"extendedFields": [
{
"identifier": "Global_Party_Form:Other_Party_Type",
"value": null
},
{
"identifier": "Global_Party_Form:ContactPerson2",
"value": null
},
{
"identifier": "Global_Incident_Form:Party_VehicleRegistration",
"value": null
},
{
"identifier": "Global_Party_Form:Mobile_Telephone_No",
"value": null
},
{
"identifier": "Global_Party_Form:Gefion (Poland):Party_Type_Of_Notification",
"value": null
},
{
"identifier": "Global_Party_Form:Email_Preference",
"value": null
},
{
"identifier": "Global_Party_Form:Letter_Preference",
"value": null
},
{
"identifier": "Global_Party_Form:Mobile_Telephone_Preference",
"value": null
},
{
"identifier": "Global_Party_Form:SMS_Preference",
"value": null
},
{
"identifier": "Global_Party_Form:Telephone_Preference",
"value": null
}
]
}