Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Description

The Student Intake API returns a wrapper transfer object that contains both the student specific data but also lookup data for the front-end view.  This was done to limit the number of calls to the back-end services and to increase performance of the front-end view.

Get Student Intake Form

GET /ssp/api/1/tool/studentintake/{id}

Security

STUDENT_INTAKE_READ

Returns

StudentIntakeForm

{"person" : 
    {"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
     "createdDate" : 1331269200000,
     "createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
     "modifiedDate" : 1331269200000,
     "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
     "objectStatus" : "ACTIVE",
     "firstName" : "Sally",
     "middleInitial" : null,
     "lastName" : "Student",
     "birthDate" : null,
     "primaryEmailAddress" : "sally.student@university.edu",
     "secondaryEmailAddress" : null,
     "username" : "sally.student",
     "userId" : null,
     "homePhone" : "123-456-7890",
     "workPhone" : null,
     "cellPhone" : null,
     "addressLine1" : "444 West Third Street",
     "addressLine2" : null,
     "city" : "Dayton",
     "state" : "OH",
     "zipCode" : "45402",
     "photoUrl" : null,
     "schoolId" : null,
     "enabled" : false,
     "coach" :
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "Amy",
         "lastName" : "Advisor",
         "primaryEmailAddress" : "amy.advisor@university.edu",
         "workPhone" : "(123) 456-7890",
         "officeLocation" : "123 Benton Hall Room A",
         "departmentName" : "Engineering & Applied Science"},
     "strengths" : "Good test taker",
     "abilityToBenefit" : true,
     "anticipatedStartTerm" : "Fall",
     "anticipatedStartYear" : "2012",
     "studentTypeId" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
     "studentIntakeRequestDate" : 1331269200000,
     "specialServiceGroupIds" : 
        [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
         {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
         ...
        ],
     "referralSourceIds" : 
        [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
         {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
         ...
        ],
     "serviceReasonIds" : 
        [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
         {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
         ...
        ]
     "currentProgramStatusName" : "Active",
     "currentAppointmentStartDate" : 1331269200000},
 "personDemographics" :
     {"id":"50b2b8dc-54ff-4bed-bbb8-c5b4311bcffc",
      "createdDate":1334146923000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334146923000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "maritalStatusId":"c30d2993-0e96-4b70-9fd1-15f83ce281c1",
      "ethnicityId":"35efc2bd-c8df-4b2e-b821-43278fdd4839",
      "citizenshipId":"66be33cb-ae0c-444f-8b3c-3e22a4cbc5cb",
      "veteranStatusId":"4b584fdb-dbc8-44ff-a30d-8c3e0a2d8295",
      "abilityToBenefit":true,
      "primaryCaregiver":false,
      "childCareNeeded":true,
      "employed":true,
      "numberOfChildren":2,
      "anticipatedStartTerm":"Fall",
      "anticipatedStartYear":"2013",
      "countryOfResidence":"USA",
      "paymentStatus":null,
      "gender":"M",
      "countryOfCitizenship":"United Kingdom",
      "childAges":"1,4",
      "placeOfEmployment":"Self Employed",
      "shift":"FIRST",
      "wage":"$25/hr",
      "totalHoursWorkedPerWeek":"60",
      "local":false},
 "personEducationGoal" :
     {"id":"859acb78-b58f-41d7-977e-4e623e16c464",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "educationGoalId":"efeb5536-d634-4b79-80bc-1e1041dcd3ff",
      "description":"Obtain Bachelor's Degree",
      "plannedOccupation":"Consultant",
      "howSureAboutMajor":1},
 "personEducationPlan" :
     {"id":"0f99b1a6-1276-46cf-bd7c-747be9641a67",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "studentStatusId":"eac2ecfc-6c32-45ed-b70d-0b23b06cfa74",
      "newOrientationComplete":true,
      "registeredForClasses":true,
      "collegeDegreeForParents":false,
      "specialNeeds":false,
      "gradeTypicallyEarned":"A"},
 "personEducationLevels":
    [{"id":"3ae66362-134a-4bb6-afb3-628e862812e8",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "educationLevelId":"459f4cb3-2274-4f47-b757-68b987f8707e",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "graduatedYear":2001,
      "highestGradeCompleted":12,
      "lastYearAttended":2001,
      "description":"test",
      "schoolName":"Miami University"},
     {"id":"edded48c-1d20-42b5-949d-eb67e47b2493",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "educationLevelId":"c5111182-9e2f-4252-bb61-d2cfa9700af7",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "graduatedYear":null,
      "highestGradeCompleted":12,
      "lastYearAttended":1999,
      "description":"test",
      "schoolName":"The Ohio State University"},
     ...
    ],
 "personFundingSources":
    [{"id":"356818e9-7444-4bd7-b743-10043bbc49c1",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "fundingSourceId":"db26cf97-02af-493a-a0e4-d3f7fa08629f",
      "description":null},
     {"id":"6baa9bc9-b1a0-406a-b2de-59dffcc2bd6e",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "fundingSourceId":"7321d900-39d1-47f3-82c6-f3c232e492aa",
      "description":null},
     ...
    ],
 "personChallenges":
    [{"id":"3c32c13a-a4e6-4fd2-9643-736601e72a2f",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "challengeId":"2fd9ab0b-4afb-43d3-8ae2-5cf462c847e5",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "description":null},
     {"id":"b9328941-9130-4307-9010-f5ca5d12eee3",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "challengeId":"07b5c3ac-3bdf-4d12-b65d-94cb55167998",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "description":null},
     ...
    ],
 "referenceData" :
     {"educationGoals" :
        [{"id":"d25e224b-a0ca-48f0-ac30-1ddf5bdb9e0d",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Associates Degree",
          "description":"Associates Degree"},
         {"id":"efeb5536-d634-4b79-80bc-1e1041dcd3ff",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Bachelor",
          "description":"Bachelor"},
         ...
        ],
     "challenges" :
        [{"id":"5d6dc03f-b000-42b1-a078-253c55867ff1",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Alcohol and/or Substance Abuse",
          "description":"Alcohol and/or Substance Abuse",
          "selfHelpGuideQuestion":null,
          "selfHelpGuideQuestions":[],
          "selfHelpGuideDescription":null,
          "showInStudentIntake":true,
          "showInSelfHelpSearch":true,
          "tags":null},
         {"id":"07b5c3ac-3bdf-4d12-b65d-94cb55167998",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Child or Adult Care",
          "description":"Child or Adult Care",
          "selfHelpGuideQuestion":null,
          "selfHelpGuideQuestions":[],
          "selfHelpGuideDescription":null,
          "showInStudentIntake":true,
          "showInSelfHelpSearch":true,
          "tags":null},
         ...
        ],
     "employmentShifts" :
        [{"code":"FIRST",
          "title":"1st"},
         {"code":"SECOND",
          "title":"2nd"},
         ...
        ],
     "studentStatuses" : 
        [{"id":"eac2ecfc-6c32-45ed-b70d-0b23b06cfa74",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Current",
          "description":"Current"},
         {"id":"c9e10b4a-6855-4a77-860f-979f8a3fd1eb",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Former",
          "description":"Former"},
         ...
        ],
     "childCareArrangements" :
        [{"id":"58828932-d2ec-4c23-a141-36656c61abbd",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Day Care",
          "description":"Day Care"},
         {"id":"b82e644e-5152-493a-8b75-1a5e4f60f316",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Family/Friend",
          "description":"Family/Friend"},
         ...
        ],
     "states" :
        [{"code":"AL",
          "title":"Alabama"},
         {"code":"AK",
          "title":"Alaska"},
         ...
        ],
     "educationLevels" :
        [{"id":"742d0a11-2f4f-4f5c-bf30-ab5c4122e66e",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Attending High School",
          "description":"Attending High School"},
         {"id":"e79e6be0-80e2-40a6-a21e-7544b08f0bce",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"College Degree - 2 Year",
          "description":"College Degree - 2 Year"},
         ...
        ],
     "genders" :
        [{"code":"M",
          "title":"Male"},
         {"code":"F",
          "title":"Female"}
        ],
     "fundingSources" :
        [{"id":"e2ca9893-c808-47ce-bea5-3b9d97ae6626",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Assistance Needed",
          "description":"Assistance Needed"},
         {"id":"77df68fe-2a5f-47ef-914b-d38774e5a485",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Employer",
          "description":"Employer"},
         ...
        ],
     "citizenships" :
        [{"id":"80c7c0b5-54d3-4e08-8102-f522f4c8f1af",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"International",
          "description":"International"},
         {"id":"66be33cb-ae0c-444f-8b3c-3e22a4cbc5cb",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Naturalized Citizen",
          "description":"Naturalized Citizen"},
         ...
        ],
     "maritalStatuses" :
        [{"id":"a159c9bf-4e94-4f68-874a-3065e2d9651e",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Divorced",
          "description":"Divorced"},
         {"id":"c30d2993-0e96-4b70-9fd1-15f83ce281c1",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Married",
          "description":"Married"},
         ...
        ],
     "veteranStatuses" :
        [{"id":"4b584fdb-dbc8-44ff-a30d-8c3e0a2d8295",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Dependent of Veteran",
          "description":"Dependent of Veteran"},
         {"id":"b106d9e6-6666-48c8-96e3-4dc0807c0557",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Montgomery County Active Duty",
          "description":"Montgomery County Active Duty"},
         ...
        ],
     "ethnicities" :
        [{"id":"9f73e1f0-66aa-47f6-a7bc-2daecb915207",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"African American/Black",
          "description":"African American/Black"},
         {"id":"35efc2bd-c8df-4b2e-b821-43278fdd4839",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"American Indian/Alaskan Native",
          "description":"American Indian/Alaskan Native"},
         ...
        ]
     }
}

 

Save the Student Intake Form

PUT /ssp/api/1/tool/studentintake/{studentId}

Security

STUDENT_INTAKE_WRITE

Sample Post

{"person" : 
    {"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
     "createdDate" : 1331269200000,
     "createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
     "modifiedDate" : 1331269200000,
     "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
     "objectStatus" : "ACTIVE",
     "firstName" : "Sally",
     "middleInitial" : null,
     "lastName" : "Student",
     "birthDate" : null,
     "primaryEmailAddress" : "sally.student@university.edu",
     "secondaryEmailAddress" : null,
     "username" : "sally.student",
     "userId" : null,
     "homePhone" : "123-456-7890",
     "workPhone" : null,
     "cellPhone" : null,
     "addressLine1" : "444 West Third Street",
     "addressLine2" : null,
     "city" : "Dayton",
     "state" : "OH",
     "zipCode" : "45402",
     "photoUrl" : null,
     "schoolId" : null,
     "enabled" : false,
     "coach" :
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "Amy",
         "lastName" : "Advisor",
         "primaryEmailAddress" : "amy.advisor@university.edu",
         "workPhone" : "(123) 456-7890",
         "officeLocation" : "123 Benton Hall Room A",
         "departmentName" : "Engineering & Applied Science"}},
     "strengths" : "Good test taker",
     "abilityToBenefit" : true,
     "anticipatedStartTerm" : "Fall",
     "anticipatedStartYear" : "2012",
     "specialServiceGroupIds" : 
        [{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
         {"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
         ...
        ],
     "referralSourceIds" : 
        [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
         {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
         ...
        ],
     "serviceReasonIds" : 
        [{"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
         {"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
         ...
        ]
     "currentProgramStatusName" : "Active",
     "currentAppointmentStartDate" : 1331269200000},
 "personDemographics" :
     {"id":"50b2b8dc-54ff-4bed-bbb8-c5b4311bcffc",
      "createdDate":1334146923000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334146923000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "maritalStatusId":"c30d2993-0e96-4b70-9fd1-15f83ce281c1",
      "ethnicityId":"35efc2bd-c8df-4b2e-b821-43278fdd4839",
      "citizenshipId":"66be33cb-ae0c-444f-8b3c-3e22a4cbc5cb",
      "veteranStatusId":"4b584fdb-dbc8-44ff-a30d-8c3e0a2d8295",
      "abilityToBenefit":true,
      "primaryCaregiver":false,
      "childCareNeeded":true,
      "employed":true,
      "numberOfChildren":2,
      "anticipatedStartTerm":"Fall",
      "anticipatedStartYear":"2013",
      "countryOfResidence":"USA",
      "paymentStatus":null,
      "gender":"M",
      "countryOfCitizenship":"United Kingdom",
      "childAges":"1,4",
      "placeOfEmployment":"Self Employed",
      "shift":"FIRST",
      "wage":"$25/hr",
      "totalHoursWorkedPerWeek":"60",
      "local":false},
 "personEducationGoal" :
     {"id":"859acb78-b58f-41d7-977e-4e623e16c464",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "educationGoalId":"efeb5536-d634-4b79-80bc-1e1041dcd3ff",
      "description":"Obtain Bachelor's Degree",
      "plannedOccupation":"Consultant",
      "howSureAboutMajor":1},     
 "personEducationPlan" :
     {"id":"0f99b1a6-1276-46cf-bd7c-747be9641a67",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":null,
      "studentStatusId":"eac2ecfc-6c32-45ed-b70d-0b23b06cfa74",
      "newOrientationComplete":true,
      "registeredForClasses":true,
      "collegeDegreeForParents":false,
      "specialNeeds":false,
      "gradeTypicallyEarned":"A"},
 "personEducationLevels":
    [{"id":"3ae66362-134a-4bb6-afb3-628e862812e8",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "educationLevelId":"459f4cb3-2274-4f47-b757-68b987f8707e",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "graduatedYear":2001,
      "highestGradeCompleted":12,
      "lastYearAttended":2001,
      "description":"test",
      "schoolName":"Miami University"},
     {"id":"edded48c-1d20-42b5-949d-eb67e47b2493",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "educationLevelId":"c5111182-9e2f-4252-bb61-d2cfa9700af7",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "graduatedYear":null,
      "highestGradeCompleted":12,
      "lastYearAttended":1999,
      "description":"test",
      "schoolName":"The Ohio State University"},
     ...
    ],
 "personFundingSources":
    [{"id":"356818e9-7444-4bd7-b743-10043bbc49c1",
      "createdDate":1334126100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334126100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "fundingSourceId":"db26cf97-02af-493a-a0e4-d3f7fa08629f",
      "description":null},
     {"id":"6baa9bc9-b1a0-406a-b2de-59dffcc2bd6e",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "fundingSourceId":"7321d900-39d1-47f3-82c6-f3c232e492aa",
      "description":null},
     ...
    ],
 "personChallenges":
    [{"id":"3c32c13a-a4e6-4fd2-9643-736601e72a2f",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "challengeId":"2fd9ab0b-4afb-43d3-8ae2-5cf462c847e5",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "description":null},
     {"id":"b9328941-9130-4307-9010-f5ca5d12eee3",
      "createdDate":1334162100000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate":1334162100000,
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus":"ACTIVE",
      "challengeId":"07b5c3ac-3bdf-4d12-b65d-94cb55167998",
      "personId":"c1a42b83-746b-467a-975e-413b28b8e6ee",
      "description":null},
     ...
    ],
 "referenceData" :
     {"educationGoals" :
         [{"id":"d25e224b-a0ca-48f0-ac30-1ddf5bdb9e0d",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Associates Degree",
           "description":"Associates Degree"},
          {"id":"efeb5536-d634-4b79-80bc-1e1041dcd3ff",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Bachelor",
           "description":"Bachelor"},
          ...
        ],
     "challenges" :
        [{"id":"5d6dc03f-b000-42b1-a078-253c55867ff1",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Alcohol and/or Substance Abuse",
          "description":"Alcohol and/or Substance Abuse",
          "selfHelpGuideQuestion":null,
          "selfHelpGuideQuestions":[],
          "selfHelpGuideDescription":null,
          "showInStudentIntake":true,
          "showInSelfHelpSearch":true,
          "tags":null},
         {"id":"07b5c3ac-3bdf-4d12-b65d-94cb55167998",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Child or Adult Care",
          "description":"Child or Adult Care",
          "selfHelpGuideQuestion":null,
          "selfHelpGuideQuestions":[],
          "selfHelpGuideDescription":null,
          "showInStudentIntake":true,
          "showInSelfHelpSearch":true,
          "tags":null},
         ...
        ],
     "employmentShifts" :
        [{"code":"FIRST",
          "title":"1st"},
         {"code":"SECOND",
          "title":"2nd"},
         ...
        ],
     "studentStatuss" : 
        [{"id":"eac2ecfc-6c32-45ed-b70d-0b23b06cfa74",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Current",
          "description":"Current"},
         {"id":"c9e10b4a-6855-4a77-860f-979f8a3fd1eb",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Former",
          "description":"Former"},
         ...
        ],
     "childCareArrangements" :
        [{"id":"58828932-d2ec-4c23-a141-36656c61abbd",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Day Care",
          "description":"Day Care"},
         {"id":"b82e644e-5152-493a-8b75-1a5e4f60f316",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Family/Friend",
          "description":"Family/Friend"},
         ...
        ],
     "states" :
        [{"code":"AL",
          "title":"Alabama"},
         {"code":"AK",
          "title":"Alaska"},
         ...
        ],
     "educationLevels" :
        [{"id":"742d0a11-2f4f-4f5c-bf30-ab5c4122e66e",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Attending High School",
          "description":"Attending High School"},
         {"id":"e79e6be0-80e2-40a6-a21e-7544b08f0bce",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"College Degree - 2 Year",
          "description":"College Degree - 2 Year"},
         ...
        ],
     "genders" :
        [{"code":"M",
          "title":"Male"},
         {"code":"F",
          "title":"Female"}
        ],
     "fundingSources" :
        [{"id":"e2ca9893-c808-47ce-bea5-3b9d97ae6626",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Assistance Needed",
          "description":"Assistance Needed"},
         {"id":"77df68fe-2a5f-47ef-914b-d38774e5a485",
          "createdDate":1332216000000,
          "createdBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "modifiedDate":1332216000000,
          "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},  
          "objectStatus":"ACTIVE",
          "name":"Employer",
          "description":"Employer"},
         ...
        ],
     "citizenships" :
         [{"id":"80c7c0b5-54d3-4e08-8102-f522f4c8f1af",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"International",
           "description":"International"},
          {"id":"66be33cb-ae0c-444f-8b3c-3e22a4cbc5cb",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Naturalized Citizen",
           "description":"Naturalized Citizen"},
          ...
         ],
     "maritalStatus" :
         [{"id":"a159c9bf-4e94-4f68-874a-3065e2d9651e",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Divorced",
           "description":"Divorced"},
          {"id":"c30d2993-0e96-4b70-9fd1-15f83ce281c1",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Married",
           "description":"Married"},
          ...
         ],
     "veteranStatus" :
         [{"id":"4b584fdb-dbc8-44ff-a30d-8c3e0a2d8295",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Dependent of Veteran",
           "description":"Dependent of Veteran"},
          {"id":"b106d9e6-6666-48c8-96e3-4dc0807c0557",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"Montgomery County Active Duty",
           "description":"Montgomery County Active Duty"},
          ...
         ],
     "ethnicitys" :
         [{"id":"9f73e1f0-66aa-47f6-a7bc-2daecb915207",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"African American/Black",
           "description":"African American/Black"},
          {"id":"35efc2bd-c8df-4b2e-b821-43278fdd4839",
           "createdDate":1332216000000,
           "createdBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "modifiedDate":1332216000000,
           "modifiedBy" : 
              {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
               "firstName" : "John",
               "lastName" : "Doe"},  
           "objectStatus":"ACTIVE",
           "name":"American Indian/Alaskan Native",
           "description":"American Indian/Alaskan Native"},
          ...
         ]
     }
}

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels