*[SDM]: Standard Data Model
For a full SDM payload to be generated from an SOH submission the associated SOH form has to be data modelled to provide structured data. Many SOH forms are not yet data modelled so full SDM payloads are not available.
iHub offers a skeleton SDM payload if forces wish to receive a basic submission instead of receiving these via email.
A skeleton SDM payload has the following entities defined:
- Skeleton Incident
- Submission
- Destination Email Addresses
- SOH Attachments
This allows a force system to extract the submission content which is included in plain text from the submission entity and the file attachments that SOH submission generates.
An example skeleton SDM payload is shown below. The attachment data has been truncated to make it easier to read so a full example can be downloaded from here.
{
"data": {
"id": "8c28c541-71a9-4d76-a114-ca941a9ccfcd",
"type": "incident",
"attributes": {
"incidentDescription": "This is a skeleton data modelled payload. See the submissionContent property of the the associated submission object for full details of this incident."
},
"relationships": {
"submission": {
"data": [
{
"id": "4806fa60-530e-1234-a9d2-8f70a51ecbbc",
"type": "submission"
}
]
}
}
},
"included": [
{
"id": "4806fa60-530e-1234-a9d2-8f70a51ecbbc",
"type": "submission",
"attributes": {
"externalReferenceId": "SingleOnlineHome",
"forceIdentifier": "42",
"category": "OCR",
"categorySubcode": "TV1",
"submissionId": "8bf76cd6-ce3c-4862-bbf7-e8563b51cb2e",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
"submitTime": "2023-06-12T15:09:33.880+01:00",
"customerReferenceNumber": "TYA-1-23-0100-000",
"ipAddress": "2a02:c7c:dabd:f600:ac01:5b84:52b8:f77e",
"submissionContent": "************************************************************************************************************************ Test protective marking copy display ************************************************************************************************************************ ------------------------------------------------------------------------------------------------------------------------ SAY THANKS ------------------------------------------------------------------------------------------------------------------------ Who do you want to thank?: An individual -------------------------------------------------------------------------------- Do you know their name or shoulder number?: No -------------------------------------------------------------------------------- Description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a dolor ligula. In sit amet justo egestas, commodo lectus eget, maximus est. Vivamus ut porttitor felis, sit amet ullamcorper urna. -------------------------------------------------------------------------------- What would you like to thank them for?: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a dolor ligula. In sit amet justo egestas, commodo lectus eget, maximus est. Vivamus ut porttitor felis, sit amet ullamcorper urna. -------------------------------------------------------------------------------- When did the event you would like to thank them for happen?: 09/09/2022 -------------------------------------------------------------------------------- If you're not sure of the exact date, or it happened over several days, please tell us more about that: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a dolor ligula. In sit amet justo egestas, commodo lectus eget, maximus est. Vivamus ut porttitor felis, sit amet ullamcorper urna. -------------------------------------------------------------------------------- Where did this happen?: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a dolor ligula. In sit amet justo egestas, commodo lectus eget, maximus est. Vivamus ut porttitor felis, sit amet ullamcorper urna. -------------------------------------------------------------------------------- Any reference numbers related to the thing you would like to thank them for: 1122 -------------------------------------------------------------------------------- Any message you want us to pass on to them: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a dolor ligula. In sit amet justo egestas, commodo lectus eget, maximus est. Vivamus ut porttitor felis, sit amet ullamcorper urna. ------------------------------------------------------------------------------------------------------------------------ YOUR CONTACT DETAILS ------------------------------------------------------------------------------------------------------------------------ First name: test -------------------------------------------------------------------------------- Middle name(s): test -------------------------------------------------------------------------------- Surname: test -------------------------------------------------------------------------------- Email address: [email protected] -------------------------------------------------------------------------------- Phone number: 111222 -------------------------------------------------------------------------------- Address: 11 22, 33 44 55 -------------------------------------------------------------------------------- Origin: Form -------------------------------------------------------------------------------- Are you happy for us to contact you about this if we need to ask for more information?: No ------------------------------------------------------------------------------------------------------------------------ ABOUT YOU ------------------------------------------------------------------------------------------------------------------------ Date of birth: 09/09/1990 -------------------------------------------------------------------------------- Ethnicity: White -------------------------------------------------------------------------------- Your faith or belief: Jewish -------------------------------------------------------------------------------- Gender: Male -------------------------------------------------------------------------------- Do you identify as trans?: No -------------------------------------------------------------------------------- Sexual orientation: Straight or heterosexual -------------------------------------------------------------------------------- Are you disabled or do you have a long-term impairment?: No ",
"highHarmFlag": "false",
"schema": "https://natmetfat.mpw.cds.co.uk/api/v1/en-GB/modelschema/nodm",
"schemaVersion": "1",
"schemaVersionGuid": "e8444b46-702a-496c-adb0-e057ad8780ff",
"closingCode": "000",
"formCode": "TV1",
"formGuid": "acf090af-452b-4289-a38e-3a496da19fcb",
"skeletonPayloadFlag": true
},
"relationships": {
"emailDestination": {
"data": [
{
"id": "f8ee7539-1efa-4282-bbd6-3d0991c533b8",
"type": "emailDestination"
}
]
},
"channelShift": {
"data": [
{
"id": "85ba80bd-51af-4d9a-87cb-2276207f90e7",
"type": "channelShift"
}
]
}
}
},
{
"id": "d978ad40-7bcf-4786-8606-71b8b6738d5d",
"type": "attachment",
"attributes": {
"attachmentName": "form-submission-TYA-1-23-0100-000.txt",
"attachmentContent": "U3VibWl0dGVkIChVVEMpOiAyMDIzLTA2LTEyVDE0OjA5OjMzLjg4MDAwMDBaDQpJUCBBZGRyZXNzOiAyYTAyOmM3YzpkYWJkOmY2MDA6YWMwMTo1Yjg0OjUyYjg6Zjc3ZQ0KVXNlciBhZ2VudDogTW96aWxsYS81LjAgKE1hY2ludG9zaDsgSW50ZWwgTWFjIE9TIFggMTBfMTVfNykgQXBwbGVXZWJLaXQvNTM3LjM2IChLSFRNTCwgbGlrZSBHZWNrbykgQ2hyb21lLzExNC4wLjAuMCBTYWZhcmkvNTM3LjM2",
"attachmentMimeType": "text/plain"
}
},
{
"id": "53af4e7a-c528-4456-8c67-9699eb7a8743",
"type": "attachment",
"attributes": {
"attachmentName": "FormSubmission-Thanks-TYA-1-23-0100-000.pdf",
"attachmentContent": "truncated example",
"attachmentMimeType": "application/pdf"
}
},
{
"id": "85ba80bd-51af-4d9a-87cb-2276207f90e7",
"type": "channelShift",
"attributes": {
}
},
{
"id": "f8ee7539-1efa-4282-bbd6-3d0991c533b8",
"type": "emailDestination",
"attributes": {
"toEmailAddresses": [
"[email protected]"
]
},
"relationships": {
"attachments": {
"data": [
{
"id": "d978ad40-7bcf-4786-8606-71b8b6738d5d",
"type": "attachment"
},
{
"id": "53af4e7a-c528-4456-8c67-9699eb7a8743",
"type": "attachment"
},
{
"id": "f4d27bc6-41d0-4d73-a314-a99f8d3c874f",
"type": "attachment"
}
]
}
}
},
{
"id": "f4d27bc6-41d0-4d73-a314-a99f8d3c874f",
"type": "attachment",
"attributes": {
"attachmentName": "FormSubmission-Thanks-TYA-1-23-0100-000.json",
"attachmentContent": "truncated example",
"attachmentMimeType": "application/json"
}
}
]
}