public interface SurveysApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<GuidCreatedOnVersionHolder> |
createSurvey(Survey survey)
Deprecated.
|
retrofit2.Call<Message> |
deleteSurvey(String surveyGuid,
DateTime createdOn,
Boolean physical)
Deprecated.
|
retrofit2.Call<SurveyList> |
getAllVersionsOfSurvey(String surveyGuid,
Boolean includeDeleted)
Deprecated.
|
retrofit2.Call<SurveyList> |
getMostRecentSurveys(Boolean includeDeleted)
Deprecated.
|
retrofit2.Call<Survey> |
getMostRecentSurveyVersion(String surveyGuid)
Deprecated.
|
retrofit2.Call<SurveyList> |
getPublishedSurveys(Boolean includeDeleted)
Deprecated.
|
retrofit2.Call<Survey> |
getPublishedSurveyVersion(String surveyGuid)
Deprecated.
|
retrofit2.Call<Survey> |
getSurvey(String surveyGuid,
DateTime createdOn)
Deprecated.
|
retrofit2.Call<GuidCreatedOnVersionHolder> |
publishSurvey(String surveyGuid,
DateTime createdOn,
Boolean newSchemaRev)
Deprecated.
|
retrofit2.Call<GuidCreatedOnVersionHolder> |
updateSurvey(String surveyGuid,
DateTime createdOn,
Survey survey)
Deprecated.
|
retrofit2.Call<GuidCreatedOnVersionHolder> |
versionSurvey(String surveyGuid,
DateTime createdOn)
Deprecated.
|
@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/surveys") retrofit2.Call<GuidCreatedOnVersionHolder> createSurvey(@Body Survey survey)
survey
- (required)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/surveys/{surveyGuid}/revisions/{createdOn}") retrofit2.Call<Message> deleteSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn, @Query(value="physical") Boolean physical)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys/{surveyGuid}/revisions") retrofit2.Call<SurveyList> getAllVersionsOfSurvey(@Path(value="surveyGuid") String surveyGuid, @Query(value="includeDeleted") Boolean includeDeleted)
surveyGuid
- Survey GUID (required)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys/{surveyGuid}/revisions/recent") retrofit2.Call<Survey> getMostRecentSurveyVersion(@Path(value="surveyGuid") String surveyGuid)
surveyGuid
- Survey GUID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys") retrofit2.Call<SurveyList> getMostRecentSurveys(@Query(value="includeDeleted") Boolean includeDeleted)
includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys/{surveyGuid}/revisions/published") retrofit2.Call<Survey> getPublishedSurveyVersion(@Path(value="surveyGuid") String surveyGuid)
surveyGuid
- Survey GUID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys/published") retrofit2.Call<SurveyList> getPublishedSurveys(@Query(value="includeDeleted") Boolean includeDeleted)
includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/surveys/{surveyGuid}/revisions/{createdOn}") retrofit2.Call<Survey> getSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}/publish") retrofit2.Call<GuidCreatedOnVersionHolder> publishSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn, @Query(value="newSchemaRev") Boolean newSchemaRev)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)newSchemaRev
- Should a new schema revision be created? (optional)@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}") retrofit2.Call<GuidCreatedOnVersionHolder> updateSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn, @Body Survey survey)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)survey
- Updated survey (required)@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}/version") retrofit2.Call<GuidCreatedOnVersionHolder> versionSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)Copyright © 2023 Sage Bionetworks. All rights reserved.