com.mailslurp.apis

Class GroupControllerApi

java.lang.Object

com.mailslurp.apis.GroupControllerApi

public class GroupControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupControllerApi()
GroupControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
GroupContactsDto	addContactsToGroup(UUID groupId, UpdateGroupContacts updateGroupContacts) Add contacts to a group
okhttp3.Call	addContactsToGroupAsync(UUID groupId, UpdateGroupContacts updateGroupContacts, ApiCallback<GroupContactsDto> _callback) Add contacts to a group (asynchronously)
okhttp3.Call	addContactsToGroupCall(UUID groupId, UpdateGroupContacts updateGroupContacts, ApiCallback _callback) Build call for addContactsToGroup
ApiResponse<GroupContactsDto>	addContactsToGroupWithHttpInfo(UUID groupId, UpdateGroupContacts updateGroupContacts) Add contacts to a group
GroupDto	createGroup(CreateGroupOptions createGroupOptions) Create a group
okhttp3.Call	createGroupAsync(CreateGroupOptions createGroupOptions, ApiCallback<GroupDto> _callback) Create a group (asynchronously)
okhttp3.Call	createGroupCall(CreateGroupOptions createGroupOptions, ApiCallback _callback) Build call for createGroup
ApiResponse<GroupDto>	createGroupWithHttpInfo(CreateGroupOptions createGroupOptions) Create a group
void	deleteGroup(UUID groupId) Delete group
okhttp3.Call	deleteGroupAsync(UUID groupId, ApiCallback<Void> _callback) Delete group (asynchronously)
okhttp3.Call	deleteGroupCall(UUID groupId, ApiCallback _callback) Build call for deleteGroup
ApiResponse<Void>	deleteGroupWithHttpInfo(UUID groupId) Delete group
PageGroupProjection	getAllGroups(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all Contact Groups in paginated format
okhttp3.Call	getAllGroupsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageGroupProjection> _callback) Get all Contact Groups in paginated format (asynchronously)
okhttp3.Call	getAllGroupsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getAllGroups
ApiResponse<PageGroupProjection>	getAllGroupsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all Contact Groups in paginated format
ApiClient	getApiClient()
String	getCustomBaseUrl()
GroupDto	getGroup(UUID groupId) Get group
okhttp3.Call	getGroupAsync(UUID groupId, ApiCallback<GroupDto> _callback) Get group (asynchronously)
okhttp3.Call	getGroupCall(UUID groupId, ApiCallback _callback) Build call for getGroup
List<GroupProjection>	getGroups() Get all groups
okhttp3.Call	getGroupsAsync(ApiCallback<List<GroupProjection>> _callback) Get all groups (asynchronously)
okhttp3.Call	getGroupsCall(ApiCallback _callback) Build call for getGroups
ApiResponse<List<GroupProjection>>	getGroupsWithHttpInfo() Get all groups
GroupContactsDto	getGroupWithContacts(UUID groupId) Get group and contacts belonging to it
okhttp3.Call	getGroupWithContactsAsync(UUID groupId, ApiCallback<GroupContactsDto> _callback) Get group and contacts belonging to it (asynchronously)
okhttp3.Call	getGroupWithContactsCall(UUID groupId, ApiCallback _callback) Build call for getGroupWithContacts
PageContactProjection	getGroupWithContactsPaginated(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get group and paginated contacts belonging to it
okhttp3.Call	getGroupWithContactsPaginatedAsync(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageContactProjection> _callback) (asynchronously) Get group and paginated contacts belonging to it
okhttp3.Call	getGroupWithContactsPaginatedCall(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getGroupWithContactsPaginated
ApiResponse<PageContactProjection>	getGroupWithContactsPaginatedWithHttpInfo(UUID groupId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get group and paginated contacts belonging to it
ApiResponse<GroupContactsDto>	getGroupWithContactsWithHttpInfo(UUID groupId) Get group and contacts belonging to it
ApiResponse<GroupDto>	getGroupWithHttpInfo(UUID groupId) Get group
int	getHostIndex()
GroupContactsDto	removeContactsFromGroup(UUID groupId, UpdateGroupContacts updateGroupContacts) Remove contacts from a group
okhttp3.Call	removeContactsFromGroupAsync(UUID groupId, UpdateGroupContacts updateGroupContacts, ApiCallback<GroupContactsDto> _callback) Remove contacts from a group (asynchronously)
okhttp3.Call	removeContactsFromGroupCall(UUID groupId, UpdateGroupContacts updateGroupContacts, ApiCallback _callback) Build call for removeContactsFromGroup
ApiResponse<GroupContactsDto>	removeContactsFromGroupWithHttpInfo(UUID groupId, UpdateGroupContacts updateGroupContacts) Remove contacts from a group
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupControllerApi

public GroupControllerApi()

GroupControllerApi

public GroupControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

addContactsToGroupCall

public okhttp3.Call addContactsToGroupCall(UUID groupId,
                                           UpdateGroupContacts updateGroupContacts,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for addContactsToGroup

Parameters:

groupId - (required)

updateGroupContacts - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

addContactsToGroup

public GroupContactsDto addContactsToGroup(UUID groupId,
                                           UpdateGroupContacts updateGroupContacts)
                                    throws ApiException

Add contacts to a group

Parameters:

groupId - (required)

updateGroupContacts - (required)

Returns:

GroupContactsDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

addContactsToGroupWithHttpInfo

public ApiResponse<GroupContactsDto> addContactsToGroupWithHttpInfo(UUID groupId,
                                                                    UpdateGroupContacts updateGroupContacts)
                                                             throws ApiException

Add contacts to a group

Parameters:

groupId - (required)

updateGroupContacts - (required)

Returns:

ApiResponse<GroupContactsDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

addContactsToGroupAsync

public okhttp3.Call addContactsToGroupAsync(UUID groupId,
                                            UpdateGroupContacts updateGroupContacts,
                                            ApiCallback<GroupContactsDto> _callback)
                                     throws ApiException

Add contacts to a group (asynchronously)

Parameters:

groupId - (required)

updateGroupContacts - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

createGroupCall

public okhttp3.Call createGroupCall(CreateGroupOptions createGroupOptions,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createGroup

Parameters:

createGroupOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createGroup

public GroupDto createGroup(CreateGroupOptions createGroupOptions)
                     throws ApiException

Create a group

Parameters:

createGroupOptions - (required)

Returns:

GroupDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createGroupWithHttpInfo

public ApiResponse<GroupDto> createGroupWithHttpInfo(CreateGroupOptions createGroupOptions)
                                              throws ApiException

Create a group

Parameters:

createGroupOptions - (required)

Returns:

ApiResponse<GroupDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createGroupAsync

public okhttp3.Call createGroupAsync(CreateGroupOptions createGroupOptions,
                                     ApiCallback<GroupDto> _callback)
                              throws ApiException

Create a group (asynchronously)

Parameters:

createGroupOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

deleteGroupCall

public okhttp3.Call deleteGroupCall(UUID groupId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for deleteGroup

Parameters:

groupId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

deleteGroup

public void deleteGroup(UUID groupId)
                 throws ApiException

Delete group

Parameters:

groupId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

deleteGroupWithHttpInfo

public ApiResponse<Void> deleteGroupWithHttpInfo(UUID groupId)
                                          throws ApiException

Delete group

Parameters:

groupId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

deleteGroupAsync

public okhttp3.Call deleteGroupAsync(UUID groupId,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Delete group (asynchronously)

Parameters:

groupId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-

getAllGroupsCall

public okhttp3.Call getAllGroupsCall(Integer page,
                                     Integer size,
                                     String sort,
                                     OffsetDateTime since,
                                     OffsetDateTime before,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getAllGroups

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllGroups

public PageGroupProjection getAllGroups(Integer page,
                                        Integer size,
                                        String sort,
                                        OffsetDateTime since,
                                        OffsetDateTime before)
                                 throws ApiException

Get all Contact Groups in paginated format

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageGroupProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllGroupsWithHttpInfo

public ApiResponse<PageGroupProjection> getAllGroupsWithHttpInfo(Integer page,
                                                                 Integer size,
                                                                 String sort,
                                                                 OffsetDateTime since,
                                                                 OffsetDateTime before)
                                                          throws ApiException

Get all Contact Groups in paginated format

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageGroupProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllGroupsAsync

public okhttp3.Call getAllGroupsAsync(Integer page,
                                      Integer size,
                                      String sort,
                                      OffsetDateTime since,
                                      OffsetDateTime before,
                                      ApiCallback<PageGroupProjection> _callback)
                               throws ApiException

Get all Contact Groups in paginated format (asynchronously)

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupCall

public okhttp3.Call getGroupCall(UUID groupId,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getGroup

Parameters:

groupId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroup

public GroupDto getGroup(UUID groupId)
                  throws ApiException

Get group

Parameters:

groupId - (required)

Returns:

GroupDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithHttpInfo

public ApiResponse<GroupDto> getGroupWithHttpInfo(UUID groupId)
                                           throws ApiException

Get group

Parameters:

groupId - (required)

Returns:

ApiResponse<GroupDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupAsync

public okhttp3.Call getGroupAsync(UUID groupId,
                                  ApiCallback<GroupDto> _callback)
                           throws ApiException

Get group (asynchronously)

Parameters:

groupId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsCall

public okhttp3.Call getGroupWithContactsCall(UUID groupId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getGroupWithContacts

Parameters:

groupId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContacts

public GroupContactsDto getGroupWithContacts(UUID groupId)
                                      throws ApiException

Get group and contacts belonging to it

Parameters:

groupId - (required)

Returns:

GroupContactsDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsWithHttpInfo

public ApiResponse<GroupContactsDto> getGroupWithContactsWithHttpInfo(UUID groupId)
                                                               throws ApiException

Get group and contacts belonging to it

Parameters:

groupId - (required)

Returns:

ApiResponse<GroupContactsDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsAsync

public okhttp3.Call getGroupWithContactsAsync(UUID groupId,
                                              ApiCallback<GroupContactsDto> _callback)
                                       throws ApiException

Get group and contacts belonging to it (asynchronously)

Parameters:

groupId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsPaginatedCall

public okhttp3.Call getGroupWithContactsPaginatedCall(UUID groupId,
                                                      Integer page,
                                                      Integer size,
                                                      String sort,
                                                      OffsetDateTime since,
                                                      OffsetDateTime before,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for getGroupWithContactsPaginated

Parameters:

groupId - (required)

page - Optional page index in group contact pagination (optional, default to 0)

size - Optional page size in group contact pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsPaginated

public PageContactProjection getGroupWithContactsPaginated(UUID groupId,
                                                           Integer page,
                                                           Integer size,
                                                           String sort,
                                                           OffsetDateTime since,
                                                           OffsetDateTime before)
                                                    throws ApiException

Get group and paginated contacts belonging to it

Parameters:

groupId - (required)

page - Optional page index in group contact pagination (optional, default to 0)

size - Optional page size in group contact pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageContactProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsPaginatedWithHttpInfo

public ApiResponse<PageContactProjection> getGroupWithContactsPaginatedWithHttpInfo(UUID groupId,
                                                                                    Integer page,
                                                                                    Integer size,
                                                                                    String sort,
                                                                                    OffsetDateTime since,
                                                                                    OffsetDateTime before)
                                                                             throws ApiException

Get group and paginated contacts belonging to it

Parameters:

groupId - (required)

page - Optional page index in group contact pagination (optional, default to 0)

size - Optional page size in group contact pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageContactProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupWithContactsPaginatedAsync

public okhttp3.Call getGroupWithContactsPaginatedAsync(UUID groupId,
                                                       Integer page,
                                                       Integer size,
                                                       String sort,
                                                       OffsetDateTime since,
                                                       OffsetDateTime before,
                                                       ApiCallback<PageContactProjection> _callback)
                                                throws ApiException

(asynchronously) Get group and paginated contacts belonging to it

Parameters:

groupId - (required)

page - Optional page index in group contact pagination (optional, default to 0)

size - Optional page size in group contact pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupsCall

public okhttp3.Call getGroupsCall(ApiCallback _callback)
                           throws ApiException

Build call for getGroups

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroups

public List<GroupProjection> getGroups()
                                throws ApiException

Get all groups

Returns:

List<GroupProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupsWithHttpInfo

public ApiResponse<List<GroupProjection>> getGroupsWithHttpInfo()
                                                         throws ApiException

Get all groups

Returns:

ApiResponse<List<GroupProjection>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getGroupsAsync

public okhttp3.Call getGroupsAsync(ApiCallback<List<GroupProjection>> _callback)
                            throws ApiException

Get all groups (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

removeContactsFromGroupCall

public okhttp3.Call removeContactsFromGroupCall(UUID groupId,
                                                UpdateGroupContacts updateGroupContacts,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for removeContactsFromGroup

Parameters:

groupId - (required)

updateGroupContacts - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

removeContactsFromGroup

public GroupContactsDto removeContactsFromGroup(UUID groupId,
                                                UpdateGroupContacts updateGroupContacts)
                                         throws ApiException

Remove contacts from a group

Parameters:

groupId - (required)

updateGroupContacts - (required)

Returns:

GroupContactsDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

removeContactsFromGroupWithHttpInfo

public ApiResponse<GroupContactsDto> removeContactsFromGroupWithHttpInfo(UUID groupId,
                                                                         UpdateGroupContacts updateGroupContacts)
                                                                  throws ApiException

Remove contacts from a group

Parameters:

groupId - (required)

updateGroupContacts - (required)

Returns:

ApiResponse<GroupContactsDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

removeContactsFromGroupAsync

public okhttp3.Call removeContactsFromGroupAsync(UUID groupId,
                                                 UpdateGroupContacts updateGroupContacts,
                                                 ApiCallback<GroupContactsDto> _callback)
                                          throws ApiException

Remove contacts from a group (asynchronously)

Parameters:

groupId - (required)

updateGroupContacts - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-