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 »

Get All Persons

GET /ssp/api/1/person

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{"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"},
          ...
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
          {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
          ...
         ]},
     {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "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" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "birthDate" : null,
      "primaryEmailAddress" : "bill.smith@university.edu",
      "secondaryEmailAddress" : null,
      "username" : "bill.smith",
      "userId" : null,
      "homePhone" : "987-65-4321",
      "workPhone" : null,
      "cellPhone" : null,
      "addressLine1" : "110 North Front 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"},
          ...
         ],
      "referralSourceIds" : 
         [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
          {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
          ...
         ]},
      ...
    ]
}

 

Get a Person

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

Returns

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,
 "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"},
     ...
    ]
}

 

Create a Person

POST /ssp/api/1/person

Sample Post

{"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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ]
}

Returns

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,
 "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"},
     ...
    ]
}

 

Save a Person

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

Sample Post

{"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"},
     ...
    ],
 "referralSourceIds" : 
    [{"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37"},
     {"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7"},
     ...
    ]
}

Returns

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,
 "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"},
     ...
    ]
}

 

Delete a Person

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

Returns

{"success" : "true"}

or

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


Get History for Person

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

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

PDF Report - To be completed by Unicon

  • No labels