retrofit.http.Headers Java Examples

@Multipart
@Headers({"Content-Type: multipart/form-data",
        "Accept: application/json",
        "Accept-Encoding: gzip, deflate"})
@POST("/api/{userID}/violation/create")
VideoAnswer uploadImage(@Part("photo") TypedFile photo,
                        @EncodedPath("userID") String userID,
                        @Part("latitude") double latitude,
                        @Part("longitude") double longitude);
 

@Headers("Accept: application/text")
@GET("/analytics/events/{dataType}/{program}"
        + ".html+css?displayProperty=NAME")
Response getEventReportTableData(@Path("program") String program,
        @Query("stage") String programStage,
        @Query("dimension") List<String> dimensions,
        @Query("outputType") String outputType,
        @Query("aggregationType") String aggregationType,
        @Query("value") String value,
        @Path("dataType") String dataType,
        @Query("filter") List<String> filter);
 

@Headers({ACCEPT_JSON_HEADER})
@FormUrlEncoded
@POST("/oauth/access_token")
BitlyOAuthToken getToken(@Header("Authorization") String authorizationHeader,
                                 @Field("grant_type") String grantType,
                                 @Field("username") String username,
                                 @Field("password") String password);
 

@Headers({
        "Accept: application/json"
})
@FormUrlEncoded
@POST("/login/oauth/access_token")
Observable<AccessTokenResponse> getOAuthToken(@Field("client_id") String client_id,
                                              @Field("client_secret") String client_secret, @Field("code") String code);
 

@Headers({
        "Content-Length: 0",
        "Accept: application/json"
})
@PUT("/user/starred/{user}/{repo}")
Observable<Object> starRepo(
        @Path("user") String user, @Path("repo") String repo,
        @Query(value = "access_token", encodeValue = true) String accessToken
);
 

@GET("/documents?paging=false")
@Headers("Accept: application/json")
Map<String, List<DashboardItemContent>> getResources(@QueryMap Map<String, String> queryMap);
 

@Headers("Cache-Control: max-age=640000")
@GET("/users/{user}/repos")
List<Repo> listRepos(@Path("user") String user);
 

@POST("Publisher/DoesContactExistByName")
@Headers({"Content-Length: 0"})
Call<ResponseBody> doesContactExist(@Query("sessionId") String sessionId,
                                    @Query("contactName") String contactName);
 

@POST("Publisher/CreateContact")
@Headers({"Content-Length: 0"})
Call<String> createContact(@Query("sessionId") String sessionId,
                                 @Query("contactName") String contactName,
                                 @Query("emailAddress") String emailAddress);
 

@POST("Publisher/DeleteContact")
@Headers({"Content-Length: 0"})
Call<ResponseBody> deleteContact(@Query("sessionId") String sessionId,
                                 @Query("contactId") String contactId);
 

@GET("/maps?paging=false")
@Headers("Accept: application/json")
Map<String, List<DashboardItemContent>> getMaps(@QueryMap Map<String, String> queryParams);
 

@Headers("Accept: application/text")
@GET("/reportTables/{id}/data.html")
Response getReportTableData(@Path("id") String id);
 

@DELETE("/26/dashboards/{dashboardUid}/items/{itemUid}/content/{contentUid}")
@Headers("Content-Type: application/json")
Response deleteDashboardItemContent(@Path("dashboardUid") String dashboardUid,
                                    @Path("itemUid") String itemUid,
                                    @Path("contentUid") String contentUid);
 

@GET("/charts?paging=false")
@Headers("Accept: application/json")
Map<String, List<DashboardItemContent>> getCharts(@QueryMap Map<String, String> queryParams);
 

@GET("/interpretations/{uid}")
@Headers("Accept: application/json")
Interpretation getInterpretation(@Path("uid") String uId, @QueryMap Map<String, String> queryMap);
 

@GET("/reportTables?paging=false")
@Headers("Accept: application/json")
Map<String, List<DashboardItemContent>> getReportTables(@QueryMap Map<String, String> queryParams);
 

@Headers("Content-Type: text/plain")
@POST("/interpretations/map/{uid}")
Response postMapInterpretation(@Path("uid") String elementUid,
                               @Body TypedString interpretationText);
 

@GET("/me/")
@Headers("Accept: application/json")
UserAccount getCurrentUserAccount(@QueryMap Map<String, String> queryParams);
 

@Headers("Content-Type: text/plain")
@POST("/interpretations/reportTable/{uid}")
Response postReportTableInterpretation(@Path("uid") String elementUid,
                                       @Body TypedString interpretationText);
 

@Headers("X-Requested-With: XMLHttpRequest")
@PUT("/api/v4/users/sessions/device")
Promise<User> attachDeviceV4(@Body User user);
 

@Headers("X-Requested-With: XMLHttpRequest")
@POST("/api/v3/users/attach_device")
Promise<User> attachDeviceV3(@Body User user);
 

@Headers("Accept: application/json")
@PATCH("/notifications/viewed")
Observable<ResponseBody> patchNotifications();
 

@Headers("Accept: application/json")
@GET("/notifications/preview")
Observable<MuResponse> getNotifications();
 

/**
 * Loads {@link #requestMethod} and {@link #requestType}.
 */
private void parseMethodAnnotations() {
    for (Annotation methodAnnotation : method.getAnnotations()) {
        Class<? extends Annotation> annotationType = methodAnnotation.annotationType();
        RestMethod methodInfo = null;

        // Look for a @RestMethod annotation on the parameter annotation indicating request method.
        for (Annotation innerAnnotation : annotationType.getAnnotations()) {
            if (RestMethod.class == innerAnnotation.annotationType()) {
                methodInfo = (RestMethod) innerAnnotation;
                break;
            }
        }

        if (methodInfo != null) {
            if (requestMethod != null) {
                throw new IllegalArgumentException("Method " + method.getName() + " contains multiple HTTP methods. Found: " + requestMethod + " and " + methodInfo.value());
            }
            String path;
            try {
                path = (String) annotationType.getMethod("value").invoke(methodAnnotation);
            } catch (Exception e) {
                throw new RuntimeException("Failed to extract path from " + annotationType.getSimpleName() + " annotation on " + method.getName() + ".", e);
            }
            parsePath(path);
            requestMethod = methodInfo.value();
            requestHasBody = methodInfo.hasBody();
        } else if (annotationType == Headers.class) {
            String[] headersToParse = ((Headers) methodAnnotation).value();
            if (headersToParse.length == 0) {
                throw new IllegalStateException("Headers annotation was empty.");
            }
            headers = parseHeaders(headersToParse);
        } else if (annotationType == Multipart.class) {
            if (requestType != RequestType.SIMPLE) {
                throw new IllegalStateException("Only one encoding annotation per method is allowed: " + method.getName());
            }
            requestType = RequestType.MULTIPART;
        } else if (annotationType == FormUrlEncoded.class) {
            if (requestType != RequestType.SIMPLE) {
                throw new IllegalStateException("Only one encoding annotation per method is allowed: " + method.getName());
            }
            requestType = RequestType.FORM_URL_ENCODED;
        }
    }

    if (requestMethod == null) {
        throw new IllegalStateException("Method " + method.getName() + " not annotated with request type (e.g., GET, POST).");
    }
    if (!requestHasBody) {
        if (requestType == RequestType.MULTIPART) {
            throw new IllegalStateException("Multipart can only be specific on HTTP methods with request body (e.g., POST). (" + method.getName() + ")");
        }
        if (requestType == RequestType.FORM_URL_ENCODED) {
            throw new IllegalStateException("Multipart can only be specific on HTTP methods with request body (e.g., POST). (" + method.getName() + ")");
        }
    }
}
 

@Headers("Accept: application/json")
@POST("/posts/{pid}/comments")
Observable<Comment> postComment(@Path("pid") long pid, @Body RequestBody body);
 

@GET("/data/2.5/find?units=metric")
@Headers("Cache-Control: max-age=300, max-stale=900")
OWMCurrentWeatherList getCurrentWeatherByCityName(@Query("q") String query);
 

@Headers("Accept: application/json")
@PUT("/users/{uid}/unfollow")
Observable<Follow> unfollow(@Path("uid") String uid);
 

@Headers("Accept: application/json")
@PUT("/posts/{pid}/comments/{cid}/unlike")
Observable<Comment> unlikedComment(@Path("pid") long pid, @Path("cid") long cid);
 

@Headers("Accept: application/json")
@PUT("/posts/{pid}/comments/{cid}/like")
Observable<Comment> likedComment(@Path("pid") long pid, @Path("cid") long cid);
 

@Headers("Accept: application/json")
@GET("/notifications/preview")
Observable<MuResponse> checkLogin();