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

Version 1 Next »

Get All Outreaches

GET /ssp/api/1/reference/outreach

Parameters

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

Returns

List<FacultySuggestion>

[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "Phone Call",
  "description" : "Phone Call.",
  "sortOrder" : 1},
 {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "Email",
  "description" : "Email.",
  "sortOrder" : 2},
 ...
]

 

Get an Outreach

GET /ssp/api/1/reference/outreach/{id}

Returns

Outreach

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Phone Call",
 "description" : "Phone Call.",
 "sortOrder" : 1}

 

Create an Outreach

POST /ssp/api/1/reference/outreach

Sample Post

{"name" : "Letter"
 "description" : "Letter."}

Returns

FacultySuggestion

{"id" : "73bfcb09-95f5-4f52-87cf-76277193d51c",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Letter",
 "description" : "Letter.",
 "sortOrder" : 3}

 

Save an Outreach

PUT /ssp/api/1/reference/outreach/{id}

Sample Post

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Phone Call",
 "description" : "Phone Call.",
 "sortOrder" : 1}

Returns

Outreach

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Phone Call",
 "description" : "Phone Call.",
 "sortOrder" : 1}

 

Delete an Outreach

DELETE /ssp/api/1/reference/outreach/{id}

Returns

{"ServiceResponse" : 
    {"success" : "true"}}

or

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