@ApplicationScoped @Path(value="/absSync/lists") public class KernelListRestServices extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DELETE_MEMBERS |
static String |
POST_MEMBERS |
static String |
PUT_MEMBERS |
static String |
REMOVE_OPERATION |
Constructor and Description |
---|
KernelListRestServices() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addOrOverwriteAccessorsForList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> accessors)
Adds or replaces Accessors in List.
|
javax.ws.rs.core.Response |
addOrOverwriteList(String tenantId,
String listId,
ListData listData)
Adds or replaces List.
|
javax.ws.rs.core.Response |
addOrOverwriteMembersToList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> members)
Adds or replaces list members.
|
javax.ws.rs.core.Response |
addOrOverwriteSendersForList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> senders)
Adds or replaces Senders in List.
|
javax.ws.rs.core.Response |
addRemoveOrUpdateAccessorsForList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> accessors,
String operation)
Adds, Removes or Updates Accessors in List.
|
javax.ws.rs.core.Response |
addRemoveOrUpdateMembersToList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> members,
String operation)
Adds, Removes or Updates list members.
|
javax.ws.rs.core.Response |
addRemoveOrUpdateSendersForList(String tenantId,
String listId,
List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> senders,
String operation)
Adds, Removes or Updates Senders in List.
|
javax.ws.rs.core.Response |
deleteAccessorsFromList(String tenantId,
String listId)
Deletes a accessors from list.
|
javax.ws.rs.core.Response |
deleteList(String tenantId,
String listId)
Deletes a list.
|
javax.ws.rs.core.Response |
deleteMembersFromList(String tenantId,
String listId)
Deletes a members from list.
|
javax.ws.rs.core.Response |
deleteSendersFromList(String tenantId,
String listId)
Deletes a senders from list.
|
javax.ws.rs.core.Response |
getAccessors(String tenantId,
String listId)
Gets all accessors of that Address Book Server list.
|
javax.ws.rs.core.Response |
getList(String tenantId,
String listId)
Gets a list from Address Book Server.
|
javax.ws.rs.core.Response |
getMembers(String tenantId,
String listId)
Gets all members of that Address Book Server list.
|
javax.ws.rs.core.Response |
getSenders(String tenantId,
String listId)
Gets all senders of that Address Book Server list.
|
public static final String PUT_MEMBERS
public static final String POST_MEMBERS
public static final String DELETE_MEMBERS
public static final String REMOVE_OPERATION
@PUT @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}") public javax.ws.rs.core.Response addOrOverwriteList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, ListData listData)
tenantId
- The id of tenantlistId
- The id of listlistData
- The ListData
object contains data related to ListResponse
object with HTTP Status code CREATED
, if List is added or overwritten successfully.javax.ws.rs.WebApplicationException
- if List is not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- List data missing.
INVALID_DATA
- List type must be 'static'.
INVALID_DATA
- List category must be 'contact', 'chat' or 'broadcast'.
INVALID_DATA
- At least one List attribute must be specified.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@DELETE @Produces(value="application/json") @Path(value="{tenantId}/{listId}") public javax.ws.rs.core.Response deleteList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of userResponse
object with HTTP Status Code OK
, if list is deleted successfully.javax.ws.rs.WebApplicationException
- if list is not deleted successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
NOT_FOUND
, if requested list not found. The Response
body contains error code - details as follows
NOT_FOUND
- List [$listId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@PUT @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/members") public javax.ws.rs.core.Response addOrOverwriteMembersToList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> members)
tenantId
- The id of tenantlistId
- The id of usermembers
- The List
object contains members of list that have two fields - tenantId and userIdResponse
object with HTTP Status Code CREATED
, if user attributes are added or overwritten successfully.javax.ws.rs.WebApplicationException
- if user attributes are not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Members data missing.
NOT_FOUND
, if requested user not found. The Response
body contains error code - details as follows
NOT_FOUND
- User [$userId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@POST @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/members") public javax.ws.rs.core.Response addRemoveOrUpdateMembersToList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> members, @QueryParam(value="op") String operation)
tenantId
- The id of tenantlistId
- The id of usermembers
- The List
object contains members of list that have two fields - tenantId and userIdop
- The operation like 'add' or 'remove'Response
object with HTTP Status Code CREATED
, if list members are added, updated or removed successfully.javax.ws.rs.WebApplicationException
- if user attributes are not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Invalid op/operation parameter
INVALID_DATA
- Unknown op/operation parameter
INVALID_DATA
- Members data missing.
NOT_FOUND
, if requested user not found. The Response
body contains error code - details as follows
NOT_FOUND
- User [$userId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@DELETE @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/members") public javax.ws.rs.core.Response deleteMembersFromList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with HTTP Status Code OK
, if members of list is deleted successfully.javax.ws.rs.WebApplicationException
- if members of list is not deleted successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
NOT_FOUND
, if requested list not found. The Response
body contains error code - details as follows
NOT_FOUND
- List [$listId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@PUT @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/senders") public javax.ws.rs.core.Response addOrOverwriteSendersForList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> senders)
tenantId
- The id of tenantlistId
- The id of listsenders
- The List<UserID>
object contains data related to Senders of ListResponse
object with HTTP Status code CREATED
, if Senders of List are added or overwritten successfully.javax.ws.rs.WebApplicationException
- if Senders of List is not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Senders data missing.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@POST @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/senders") public javax.ws.rs.core.Response addRemoveOrUpdateSendersForList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> senders, @QueryParam(value="op") String operation)
tenantId
- The id of tenantlistId
- The id of listsenders
- The List
object contains data related to Senders of Listop
- The operation like 'add' or 'remove'Response
object with HTTP Status code CREATED
, if Senders of List are added, updated or removed successfully.javax.ws.rs.WebApplicationException
- if Senders of List is not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Invalid op/operation parameter
INVALID_DATA
- Unknown op/operation parameter
INVALID_DATA
- Senders data missing.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@DELETE @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/senders") public javax.ws.rs.core.Response deleteSendersFromList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with HTTP Status Code OK
, if senders of list is deleted successfully.javax.ws.rs.WebApplicationException
- if senders of list is not deleted successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
NOT_FOUND
, if requested list not found. The Response
body contains error code - details as follows
NOT_FOUND
- List [$listId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@PUT @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/accessors") public javax.ws.rs.core.Response addOrOverwriteAccessorsForList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> accessors)
tenantId
- The id of tenantlistId
- The id of listaccessors
- The List<UserID>
object contains data related to Accessors of ListResponse
object with HTTP Status code CREATED
, if Senders of List are added or overwritten successfully.javax.ws.rs.WebApplicationException
- if Accessors of List is not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Accessors data missing.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@POST @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/accessors") public javax.ws.rs.core.Response addRemoveOrUpdateAccessorsForList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId, List<com.kobil.ssms.kernel.logic.syncservice.list.dto.UserID> accessors, @QueryParam(value="op") String operation)
tenantId
- The id of tenantlistId
- The id of listaccessors
- The List
object contains data related to Accessors of Listop
- The operation like 'add' or 'remove'Response
object with HTTP Status code CREATED
, if Accessors of List are added, updated or removed successfully.javax.ws.rs.WebApplicationException
- if Accessors of List is not added successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
INVALID_DATA
- Invalid op/operation parameter
INVALID_DATA
- Unknown op/operation parameter
INVALID_DATA
- Accessors data missing.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@DELETE @Consumes(value="application/json") @Produces(value="application/json") @Path(value="{tenantId}/{listId}/accessors") public javax.ws.rs.core.Response deleteAccessorsFromList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with HTTP Status Code OK
, if accessors of list is deleted successfully.javax.ws.rs.WebApplicationException
- if accessors of list is not deleted successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
NOT_FOUND
, if requested list not found. The Response
body contains error code - details as follows
NOT_FOUND
- List [$listId] does not exist.
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@GET @Produces(value="application/json") @Path(value="{tenantId}/{listId}") public javax.ws.rs.core.Response getList(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with a JSON Body containing the list object, if list is fetched successfully.javax.ws.rs.WebApplicationException
- If list couldn't be fetched successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@GET @Produces(value="application/json") @Path(value="{tenantId}/{listId}/members") public javax.ws.rs.core.Response getMembers(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with a JSON Body containing a list of member objects, if members are fetched successfully.javax.ws.rs.WebApplicationException
- If members couldn't be fetched successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@GET @Produces(value="application/json") @Path(value="{tenantId}/{listId}/accessors") public javax.ws.rs.core.Response getAccessors(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with a JSON Body containing a list of accessor objects, if accessors are fetched successfully.javax.ws.rs.WebApplicationException
- If accessors couldn't be fetched successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
@GET @Produces(value="application/json") @Path(value="{tenantId}/{listId}/senders") public javax.ws.rs.core.Response getSenders(@PathParam(value="tenantId") String tenantId, @PathParam(value="listId") String listId)
tenantId
- The id of tenantlistId
- The id of listResponse
object with a JSON Body containing a list of sender objects, if senders are fetched successfully.javax.ws.rs.WebApplicationException
- If senders couldn't be fetched successfully. It contains Response
object with following HTTP Response.Status
codes and response body.
Response.Status.BAD_REQUEST
, if invalid user input. The Response
body contains error code - details as follows
INVALID_DATA
- Invalid tenantId
INVALID_DATA
- Invalid listId
Response.Status.SERVICE_UNAVAILABLE
, if services not available due to heavy load. The Response
body contains error code - details as follows
SERVICE_UNAVAILABLE
- The server is currently unable to handle the request due to a temporary overloading, please try again later.
Response.Status.INTERNAL_SERVER_ERROR
, if internal server error on synchronizing data or Operation timeout. The Response
body contains error code - details as follows
REQUEST_TIMEOUT
- Operation timeout, but it might processed successfully at server.
GENERAL_ERROR
- Address Book Synchronization is disabled. Enable it by providing AddressBook Server Configuration in Administration -> Advanced Settings tab."
GENERAL_ERROR
- Internal Server Error. Please try again after some time.
Copyright © 2022 KOBIL Systems GmbH. All rights reserved.