AlbumsSharingApi

All URIs are relative to http://localhost

Method	HTTP request	Description
fotowebMePeopleGet	GET /fotoweb/me/people/	Search among the users and groups you have permission to share albums with
fotowebMePeopleGetWithHttpInfo	GET /fotoweb/me/people/	Search among the users and groups you have permission to share albums with
fotowebUsersUseridAlbumsAlbumidGet	GET /fotoweb/users/{userid}/albums/{albumid}/	Get all information for an album for a specfic user; including properties, assets in the album etc.
fotowebUsersUseridAlbumsAlbumidGetWithHttpInfo	GET /fotoweb/users/{userid}/albums/{albumid}/	Get all information for an album for a specfic user; including properties, assets in the album etc.
fotowebUsersUseridAlbumsAlbumidSharesGet	GET /fotoweb/users/{userid}/albums/{albumid}/.shares/	Gets sharing details for an album for a specfic user; including any shares, public link and user/groups shares
fotowebUsersUseridAlbumsAlbumidSharesGetWithHttpInfo	GET /fotoweb/users/{userid}/albums/{albumid}/.shares/	Gets sharing details for an album for a specfic user; including any shares, public link and user/groups shares
fotowebUsersUseridAlbumsAlbumidSharesPatch	PATCH /fotoweb/users/{userid}/albums/{albumid}/.shares/	Make updates to album sharing for an album.
fotowebUsersUseridAlbumsAlbumidSharesPatchWithHttpInfo	PATCH /fotoweb/users/{userid}/albums/{albumid}/.shares/	Make updates to album sharing for an album.

fotowebMePeopleGet

PeopleList fotowebMePeopleGet(q)

Search among the users and groups you have permission to share albums with

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String q = "q_example"; // String | Query for user(s) and group(s), e.g. q=consumer 
        try {
            PeopleList result = apiInstance.fotowebMePeopleGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebMePeopleGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
q	String	Query for user(s) and group(s), e.g. q=consumer

Return type

PeopleList

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.people-list+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	400 Bad request	-
401	401 Unauthorized	-

fotowebMePeopleGetWithHttpInfo

ApiResponse fotowebMePeopleGet fotowebMePeopleGetWithHttpInfo(q)

Search among the users and groups you have permission to share albums with

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String q = "q_example"; // String | Query for user(s) and group(s), e.g. q=consumer 
        try {
            ApiResponse<PeopleList> response = apiInstance.fotowebMePeopleGetWithHttpInfo(q);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebMePeopleGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
q	String	Query for user(s) and group(s), e.g. q=consumer

Return type

ApiResponse<PeopleList>

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.people-list+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	400 Bad request	-
401	401 Unauthorized	-

fotowebUsersUseridAlbumsAlbumidGet

CollectionInfo fotowebUsersUseridAlbumsAlbumidGet(userid, albumid)

Get all information for an album for a specfic user; including properties, assets in the album etc.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        try {
            CollectionInfo result = apiInstance.fotowebUsersUseridAlbumsAlbumidGet(userid, albumid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album

Return type

CollectionInfo

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.collectioninfo+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

fotowebUsersUseridAlbumsAlbumidGetWithHttpInfo

ApiResponse fotowebUsersUseridAlbumsAlbumidGet fotowebUsersUseridAlbumsAlbumidGetWithHttpInfo(userid, albumid)

Get all information for an album for a specfic user; including properties, assets in the album etc.

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        try {
            ApiResponse<CollectionInfo> response = apiInstance.fotowebUsersUseridAlbumsAlbumidGetWithHttpInfo(userid, albumid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album

Return type

ApiResponse<CollectionInfo>

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.collectioninfo+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

fotowebUsersUseridAlbumsAlbumidSharesGet

Sharing fotowebUsersUseridAlbumsAlbumidSharesGet(userid, albumid)

Gets sharing details for an album for a specfic user; including any shares, public link and user/groups shares

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        try {
            Sharing result = apiInstance.fotowebUsersUseridAlbumsAlbumidSharesGet(userid, albumid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidSharesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album

Return type

Sharing

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.sharing+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

fotowebUsersUseridAlbumsAlbumidSharesGetWithHttpInfo

ApiResponse fotowebUsersUseridAlbumsAlbumidSharesGet fotowebUsersUseridAlbumsAlbumidSharesGetWithHttpInfo(userid, albumid)

Gets sharing details for an album for a specfic user; including any shares, public link and user/groups shares

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        try {
            ApiResponse<Sharing> response = apiInstance.fotowebUsersUseridAlbumsAlbumidSharesGetWithHttpInfo(userid, albumid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidSharesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album

Return type

ApiResponse<Sharing>

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.fotoware.sharing+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

fotowebUsersUseridAlbumsAlbumidSharesPatch

SharingLinkList fotowebUsersUseridAlbumsAlbumidSharesPatch(userid, albumid, sharingUpdate)

Make updates to album sharing for an album.

This is mainly used for enabling/disabling Download permissions on public sharing link

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        SharingUpdate sharingUpdate = new SharingUpdate(); // SharingUpdate | 
        try {
            SharingLinkList result = apiInstance.fotowebUsersUseridAlbumsAlbumidSharesPatch(userid, albumid, sharingUpdate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidSharesPatch");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album
sharingUpdate	SharingUpdate		[optional]

Return type

SharingLinkList

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: application/vnd.fotoware.sharing-update+json
Accept: application/json, application/vnd.fotoware.sharing-link-list+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

fotowebUsersUseridAlbumsAlbumidSharesPatchWithHttpInfo

ApiResponse fotowebUsersUseridAlbumsAlbumidSharesPatch fotowebUsersUseridAlbumsAlbumidSharesPatchWithHttpInfo(userid, albumid, sharingUpdate)

Make updates to album sharing for an album.

This is mainly used for enabling/disabling Download permissions on public sharing link

Example

// Import classes:
import com.cominvent.fotoware.client.ApiClient;
import com.cominvent.fotoware.client.ApiException;
import com.cominvent.fotoware.client.ApiResponse;
import com.cominvent.fotoware.client.Configuration;
import com.cominvent.fotoware.client.auth.*;
import com.cominvent.fotoware.client.models.*;
import com.cominvent.fotoware.api.AlbumsSharingApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP bearer authorization: FotoWareAccessToken
        HttpBearerAuth FotoWareAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("FotoWareAccessToken");
        FotoWareAccessToken.setBearerToken("BEARER TOKEN");

        AlbumsSharingApi apiInstance = new AlbumsSharingApi(defaultClient);
        String userid = "userid_example"; // String | Unique ID of the user
        String albumid = "albumid_example"; // String | Unique ID of the album
        SharingUpdate sharingUpdate = new SharingUpdate(); // SharingUpdate | 
        try {
            ApiResponse<SharingLinkList> response = apiInstance.fotowebUsersUseridAlbumsAlbumidSharesPatchWithHttpInfo(userid, albumid, sharingUpdate);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumsSharingApi#fotowebUsersUseridAlbumsAlbumidSharesPatch");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userid	String	Unique ID of the user
albumid	String	Unique ID of the album
sharingUpdate	SharingUpdate		[optional]

Return type

ApiResponse<SharingLinkList>

Authorization

FotoWareAccessToken

HTTP request headers

Content-Type: application/vnd.fotoware.sharing-update+json
Accept: application/json, application/vnd.fotoware.sharing-link-list+json

HTTP response details

Status code	Description	Response headers
200	200 OK	-

FilesExpand file tree

AlbumsSharingApi.md

Latest commit

History

AlbumsSharingApi.md

File metadata and controls

AlbumsSharingApi

fotowebMePeopleGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebMePeopleGetWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidGetWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidSharesGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidSharesGetWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidSharesPatch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fotowebUsersUseridAlbumsAlbumidSharesPatchWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details