SCRAM Nexus API Resource Guide

Field Visits

When field visit is marked as Attended/Attempted in Nexus probation application, the details are made available immediately to case management system.

Message structure for Field Visit:

  • Client Identifier
  • Activity
    • Type: “Field Visit”
    • Identifier
  • Details
    • DateTime
    • Status: “Attended/Attempted”
    • VisitedLocations
    • FoundContrabands
    • Note
  • Action
    • Reason: “Created/Updated”
    • OccurredOn
    • UpdatedBy

Sample Message:

{

"Client": {

"IntegrationId": "EX123456"

},

"Activity": {

"Type": "FieldVisit",

"Identifier": "00000000-0000-0000-0000-000000000000"

},

"Details": {

"Datetime": "2019-02-15T14:25Z",

"Status": "Attended",

"VisitedLocations": [

{

"Address": "Main Street Office",

"Type": "Home Address",

"ClientPresent": "Yes",

"SearchedAreas": "Client Areas, Vehicles"

}

],

"FoundContrabands": [],

"Note": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"

},

"Action": {

"Reason": "Created",

"OccurredOn": "2019-02-17T14:52:23.0272547Z",

"UpdatedBy": "officer@county.org"

}

}