...
| 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",
"specialServiceGroupIds" :
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08"},
...
]},
{ "idreferralSourceIds" : "63d62297-bf08-496f-acf3-0c129d437c2b",
[{"createdDateid" : 1331269200000,
"createdBy" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
{"id" : "91f46e3955aebdf7-cea8466b-422b49c4-b215a08c-00f6bcf5d2806e01eaf101d7"},
...
"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",
"birthDate" : null, "primaryEmailAddress"lastName" : "bill.smith@university.eduDoe"},
"secondaryEmailAddressobjectStatus" : null"ACTIVE",
"usernamefirstName" : "bill.smithBill",
"userIdmiddleInitial" : null,
"homePhonelastName" : "987-65-4321Smith",
"workPhonebirthDate" : null,
"cellPhoneprimaryEmailAddress" : null"bill.smith@university.edu",
"addressLine1secondaryEmailAddress" : "110null,
North Front Street", "addressLine2username" : null"bill.smith",
"cityuserId" : "Dayton"null,
"statehomePhone" : "OH987-65-4321",
"zipCodeworkPhone" : "45402"null,
"photoUrlcellPhone" : null,
"schoolIdaddressLine1" : null"110 North Front Street",
"enabledaddressLine2" : falsenull,
"coachIdcity" : "10d6f4f2-cd80-4454-a475-4293dbaff436"Dayton",
"specialServiceGroupIdsstate" :
"OH",
[{"idzipCode" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
45402",
{"idphotoUrl" : "7bf36968-ad48-4c5f-9838-ebf495713c08"}null,
"schoolId" : null,
... "enabled" : ]}false,
... "coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436"
"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"},
...
]},
...
]
} |
Get a Person
GET /ssp/api/1/person/{id}
...
| 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",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"specialServiceGroupIds" : null,
[{"schoolIdid" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
"enabled" : false, {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
"specialServiceGroupIds...
],
"referralSourceIds" :
[{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
{"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
...
]
} |
Create a Person
POST /ssp/api/1/person
...
| 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",
"photoUrlspecialServiceGroupIds" : null,
[{"schoolIdid" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
"enabled" : false, {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
"specialServiceGroupIds...
],
"referralSourceIds" :
[{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
{"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
...
]
} |
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",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"specialServiceGroupIds" : null,
[{"schoolIdid" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
"enabled" : false, {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
"specialServiceGroupIds...
],
"referralSourceIds" :
[{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
{"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
...
]
} |
Save a Person
PUT /ssp/api/1/person/{id}
...
| 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",
"addressLine2" : null,
"city" : "Dayton",
"state" : "OH",
"zipCode" : "45402",
"photoUrl" : null,
"schoolId" : null,
"enabled" : false,
"coachId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"specialServiceGroupIds" :
null, [{"schoolIdid" : null"437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
"enabled" : false, {"coachIdid" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436ebf495713c08"},
"specialServiceGroupIds ...
],
"referralSourceIds" :
[{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
{"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
...
]
} |
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" : null"444 West Third Street",
"addressLine2" : null,
"city" : "Dayton",
"cellPhonestate" : null"OH",
"addressLine1zipCode" : "444 West Third Street45402",
"addressLine2photoUrl" : null,
"cityschoolId" : "Dayton"null,
"stateenabled" : "OH"false,
"zipCodecoachId" : "4540210d6f4f2-cd80-4454-a475-4293dbaff436",
"photoUrlspecialServiceGroupIds" : null,
"schoolId" : null,
"enabled" : false,
"coachId
[{"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d"},
{"id" : "10d6f4f27bf36968-cd80ad48-44544c5f-a4759838-4293dbaff436"ebf495713c08"},
...
],
"specialServiceGroupIdsreferralSourceIds" :
[{"id" : "437f6f2ba8c83fd4-7b1eee33-47b446ee-86038d89-9e1208605c0d9b2956696f37"},
{"id" : "7bf3696855aebdf7-ad48466b-4c5f49c4-9838a08c-ebf495713c086e01eaf101d7"},
...
]
} |
Delete a Person
DELETE /ssp/api/1/person/{id}
...