Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"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,
      "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "strengths" : "Good test taker",
      "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"},
          ...
         ]},
     { "idserviceReasonIds" : "63d62297-bf08-496f-acf3-0c129d437c2b",
         [{"createdDateid" : 1331269200000,
      "createdBy" :"d95ea029-90c1-4be0-b547-8054fc6914b7"},
          {"id" : "91f46e39c9ff0ce6-cea8aec6-422b4be2-b215b1d1-00f6bcf5d2809ca385edc637"},
          "firstName" : "John",...
         ]},
     {"lastNameid" : "Doe"}, 63d62297-bf08-496f-acf3-0c129d437c2b",
      "modifiedDatecreatedDate" : 1331269200000,
      "modifiedBycreatedBy" :
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"}, 
      "objectStatusmodifiedDate" : "ACTIVE"1331269200000,
      "firstNamemodifiedBy" :
"Bill",         {"middleInitialid" : null,"91f46e39-cea8-422b-b215-00f6bcf5d280",
          "lastNamefirstName" : "SmithJohn",
          "birthDatelastName" : null"Doe"}, 
      "primaryEmailAddressobjectStatus" : "bill.smith@university.eduACTIVE",
      "secondaryEmailAddressfirstName" : null"Bill",
      "usernamemiddleInitial" : "bill.smith"null,
      "userIdlastName" : null"Smith",
      "homePhonebirthDate" : "987-65-4321"null,
      "workPhoneprimaryEmailAddress" : null"bill.smith@university.edu",
      "cellPhonesecondaryEmailAddress" : null,
      "addressLine1username" : "110 North Front Streetbill.smith",
      "addressLine2userId" : null,
      "cityhomePhone" : "Dayton"987-65-4321",
      "stateworkPhone" : "OH"null,
      "zipCodecellPhone" : "45402"null,
      "photoUrladdressLine1" : null "110 North Front Street",
      "schoolIdaddressLine2" : null,
      "enabledcity" : false"Dayton",
      "coachIdstate" : "10d6f4f2-cd80-4454-a475-4293dbaff436"OH",
      "strengthszipCode" : "Great communication skills45402",
      "specialServiceGroupIdsphotoUrl" : 
 null,
       [{"idschoolId" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
   null,
      "enabled" : false,
      {"idcoachId" : "7bf3696810d6f4f2-ad48cd80-4c5f4454-9838a475-ebf495713c084293dbaff436"},
      "strengths" : "Great  ...
         ]communication skills",
      "referralSourceIdsspecialServiceGroupIds" : 
         [{"id" : "a8c83fd4437f6f2b-ee337b1e-46ee47b4-8d898603-9b2956696f379e1208605c0d"},
          {"id" : "55aebdf77bf36968-466bad48-49c44c5f-a08c9838-6e01eaf101d7ebf495713c08"},
          ...
         ]},
      "referralSourceIds" : 
   ...     ]
}

 

Get a Person

GET /ssp/api/1/person/{id}

Returns

Person

Code Block
{ [{"id" : "58ba5ee3a8c83fd4-734eee33-4ae946ee-b9c58d89-943774b4de419b2956696f37"},
  "createdDate" : 1331269200000,  "createdBy" :
    {"id" : "91f46e3955aebdf7-cea8466b-422b49c4-b215a08c-00f6bcf5d2806e01eaf101d7"},
     "firstName" : "John",     ...
       "lastName" : "Doe"},],
      "modifiedDateserviceReasonIds" : 1331269200000,
   "modifiedBy" :     [{"id" : "91f46e39d95ea029-cea890c1-422b4be0-b215b547-00f6bcf5d2808054fc6914b7"},
     "firstName     {"id" : "John"c9ff0ce6-aec6-4be2-b1d1-9ca385edc637"},
     "lastName" : "Doe"},   "objectStatus" : "ACTIVE",
 "firstName" : "Sally",
 "middleInitial" : null,
 "lastName" : "Student",
 "birthDate" : null,
 "primaryEmailAddress" : "sally.student@university.edu...
         ]},
      ...
    ]
}

 

Get a Person

GET /ssp/api/1/person/{id}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "secondaryEmailAddresscreatedDate" : null1331269200000,
 "usernamecreatedBy" :
"sally.student",  "userId" : null,
 "homePhone{"id" : "123-456-789091f46e39-cea8-422b-b215-00f6bcf5d280",
     "workPhonefirstName" : null"John",
 "cellPhone" : null,  "addressLine1lastName" : "444 West Third Street"Doe"}, 
 "addressLine2modifiedDate" : null1331269200000,
 "citymodifiedBy" :
  "Dayton",  {"stateid" : "OH91f46e39-cea8-422b-b215-00f6bcf5d280",
     "zipCodefirstName" : "45402John",
 "photoUrl" : null,  "schoolIdlastName" : null,  "enabledDoe" :}, false,
 "coachIdobjectStatus" : "10d6f4f2-cd80-4454-a475-4293dbaff436ACTIVE",
 "strengthsfirstName" : "Good test takerSally",
 "specialServiceGroupIdsmiddleInitial" : 
 null,
  [{"idlastName" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"}Student",
 "birthDate" : null,
 {"idprimaryEmailAddress" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}sally.student@university.edu",
 "secondaryEmailAddress" : null,
 ...
    ]"username" : "sally.student",
 "referralSourceIdsuserId" : null,
    [{"idhomePhone" : "a8c83fd4123-ee33-46ee-8d89-9b2956696f37"}456-7890",
 "workPhone" : null,
 {"idcellPhone" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ]
}

 

Create a Person

POST /ssp/api/1/person

Sample Post

Code Block
{"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,
 "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
 "strengths" : "Good test taker",
 "specialServiceGroupIdsnull,
 "addressLine1" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "photoUrl" : null,
 "schoolId" : null,
 "enabled" : false,
 "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
 "strengths" : "Good test taker",
 "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"},
     ...
    ]
}

 

Create a Person

POST /ssp/api/1/person

Sample Post

Code Block
{"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,
 "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
 "strengths" : "Good test taker",
 "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"},
     ...
    ]
}

Returns

Person

Code Block
{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
 "createdDate" : 1331269200000,
 "createdBy" :
     [{"id" : "437f6f2b91f46e39-7b1ecea8-47b4422b-8603-9e1208605c0d"}b215-00f6bcf5d280",
     "firstName" : "John",
     {"idlastName" : "7bf36968-ad48-4c5f-9838-ebf495713c08Doe"}, 
 "modifiedDate"   ...
    ]: 1331269200000,
 "referralSourceIdsmodifiedBy" :
     [{"id" : "a8c83fd491f46e39-ee33cea8-46ee422b-8d89b215-9b2956696f3700f6bcf5d280"},
     {"idfirstName" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"}John",
     ...
 "lastName" : "Doe"}, 
 ]
}

Returns

Person

Code Block
{"id"objectStatus" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41ACTIVE",
 "createdDatefirstName" : 1331269200000"Sally",
 "createdBymiddleInitial" : null,
   {"idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280Student",
 "birthDate" : null,
 "firstNameprimaryEmailAddress" : "Johnsally.student@university.edu",
     "lastNamesecondaryEmailAddress" : "Doe"}null, 
 "modifiedDateusername" : 1331269200000"sally.student",
 "modifiedByuserId" : null,
   {"idhomePhone" : "91f46e39123-cea8-422b-b215-00f6bcf5d280456-7890",
 "workPhone" : null,
 "firstNamecellPhone" : null,
 "JohnaddressLine1", : "444 West Third Street",
 "lastNameaddressLine2" : "Doe"}null,
  "objectStatuscity" : "ACTIVEDayton",
 "firstNamestate" : "SallyOH",
 "middleInitialzipCode" : null"45402",
 "lastNamephotoUrl" : "Student"null,
 "birthDateschoolId" : null,
 "primaryEmailAddressenabled" : "sally.student@university.edu"false,
 "secondaryEmailAddresscoachId" : null"10d6f4f2-cd80-4454-a475-4293dbaff436",
 "usernamestrengths" : "sally.studentGood test taker",
 "userIdspecialServiceGroupIds" : null,
    [{"homePhoneid" : "123-456-7890"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
 "workPhone" : null,  "cellPhone" : null,  {"addressLine1id" : "444 West Third Street",
 "addressLine2" : null,
 "city" : "Dayton""7bf36968-ad48-4c5f-9838-ebf495713c08"},
     ...
    ],
 "statereferralSourceIds" : "OH",
 "zipCode" : "45402",
 "photoUrl [{"id" : null,
 "schoolId" : null"a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
 "enabled" : false,  {"coachIdid" : "10d6f4f255aebdf7-cd80466b-445449c4-a475a08c-4293dbaff4366e01eaf101d7"},
 "strengths    ...
    ],
 "serviceReasonIds" : "Good
 test taker",  [{"specialServiceGroupIdsid" : "d95ea029-90c1-4be0-b547-8054fc6914b7"},
     [{"id" : "437f6f2bc9ff0ce6-7b1eaec6-47b44be2-8603b1d1-9e1208605c0d9ca385edc637"},
     ...
    ]
}

 

Save a Person

PUT /ssp/api/1/person/{id}

Sample Post

Code Block
{"id" : "7bf3696858ba5ee3-ad48734e-4c5f4ae9-9838b9c5-ebf495713c08943774b4de41"},
     ...
    ]"createdDate" : 1331269200000,
 "referralSourceIdscreatedBy" : 
    [{"id" : "a8c83fd491f46e39-ee33cea8-46ee422b-8d89b215-9b2956696f3700f6bcf5d280"},
     {"idfirstName" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
 John",
   ...
    ]
}

 

Save a Person

PUT /ssp/api/1/person/{id}

Sample Post

Code Block
{"id  "lastName" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",Doe"}, 
 "createdDatemodifiedDate" : 1331269200000,
 "createdBymodifiedBy" :
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDateobjectStatus" : 1331269200000"ACTIVE",
 "modifiedByfirstName" :  "Sally",
  {"idmiddleInitial" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 null,
   "firstNamelastName" : "JohnStudent",
 "birthDate" : null,
 "lastNameprimaryEmailAddress" : "Doe"}"sally.student@university.edu",
  "objectStatussecondaryEmailAddress" : "ACTIVE"null,
 "firstNameusername" : "Sallysally.student",
 "middleInitialuserId" : null,
 "lastNamehomePhone" : "Student123-456-7890",
 "birthDateworkPhone" : null,
 "primaryEmailAddresscellPhone" : "sally.student@university.edu"null,
 "secondaryEmailAddressaddressLine1" : null "444 West Third Street",
 "usernameaddressLine2" : "sally.student"null,
 "userIdcity" : null"Dayton",
 "homePhonestate" : "123-456-7890"OH",
 "workPhonezipCode" : null"45402",
 "cellPhonephotoUrl" : null,
 "addressLine1schoolId" : "444 West Third Street"null,
 "addressLine2enabled" : nullfalse,
 "citycoachId" : "Dayton10d6f4f2-cd80-4454-a475-4293dbaff436",
 "statestrengths" : "OHGood test taker",
 "zipCodespecialServiceGroupIds" : "45402", 
    [{"photoUrlid" : null,
 "schoolId" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
 "enabled" : false,  {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
 "strengths" : "Good test taker"    ...
    ],
 "specialServiceGroupIdsreferralSourceIds" : 
    [{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
     {"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
     ...
    ],
 "referralSourceIdsserviceReasonIds" : 
    [{"id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7"},
     {"id" : "55aebdf7c9ff0ce6-466baec6-49c44be2-a08cb1d1-6e01eaf101d79ca385edc637"},
     ...
    ]
}

Returns

Person

Code Block
{"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 Street",
 "addressLine2" : null,
 "city" : "Dayton",
 "state" : "OH",
 "zipCode" : "45402",
 "addressLine2photoUrl" : null,
 "cityschoolId" : null,
 "Daytonenabled" : false,
 "statecoachId" : "OH10d6f4f2-cd80-4454-a475-4293dbaff436",
 "zipCodestrengths" : "45402Good test taker",
 "photoUrlspecialServiceGroupIds" : null,
    [{"schoolIdid" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
 "enabled" : false,  {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
  "strengths" : "Good test taker"   ...
    ],
 "specialServiceGroupIdsreferralSourceIds" : 
    [{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
     {"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
     ...
    ],
 "referralSourceIdsserviceReasonIds" : 
    [{"id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7"},
     {"id" : "55aebdf7c9ff0ce6-466baec6-49c44be2-a08cb1d1-6e01eaf101d79ca385edc637"},
     ...
    ]
}

 

Delete a Person

...