# saint_api

All URIs are relative to *https://dev-sg.portal.hocvienconggiao.com*

Method | HTTP request | Description
------------- | ------------- | -------------
**addSaint**](saint_api.md#addSaint) | **POST** /mutation-api/saint-service/saints | Add new saint
**delete_saint**](saint_api.md#delete_saint) | **DELETE** /mutation-api/saint-service/saints/{id} | Deletes a saint
**getAllSaints**](saint_api.md#getAllSaints) | **GET** /query-api/saint-service/saints | Get all saints
**get_saint_by_id**](saint_api.md#get_saint_by_id) | **GET** /query-api/saint-service/saints/{id} | Find saint by ID
**update_saint**](saint_api.md#update_saint) | **PUT** /mutation-api/saint-service/saints/{id} | Update an existing saint


# **addSaint**
> models::Saint addSaint(ctx, saint)
Add new saint

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **saint** | [**Saint**](Saint.md)| Saint object that needs to be added to the database | 

### Return type

[**models::Saint**](Saint.md)

### Authorization

[saint_auth](../README.md#saint_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_saint**
> delete_saint(ctx, id)
Deletes a saint

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **id** | [****](.md)| ID of saint to delete | 

### Return type

 (empty response body)

### Authorization

[saint_auth](../README.md#saint_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAllSaints**
> models::SaintCollection getAllSaints(ctx, optional)
Get all saints

Returns all saints

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **gender** | [****](.md)|  | 
 **display_name** | **String**|  | 
 **vietnamese_name** | **String**|  | 
 **english_name** | **String**|  | 
 **feast_day** | **String**| feast day in format DD-MM | 
 **sorts** | [**models::SaintSortCriteria**](models::SaintSortCriteria.md)| to sort +displayName for ASC and -displayName for DESC | 
 **offset** | **i32**| The number of saints to skip before starting to collect the result set. | 
 **count** | **i32**| The number of saints to return. | [default to 20]

### Return type

[**models::SaintCollection**](SaintCollection.md)

### Authorization

[saint_auth](../README.md#saint_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_saint_by_id**
> models::Saint get_saint_by_id(ctx, id)
Find saint by ID

Returns a single saint

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **id** | [****](.md)| ID of saint to return | 

### Return type

[**models::Saint**](Saint.md)

### Authorization

[saint_auth](../README.md#saint_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_saint**
> models::Saint update_saint(ctx, id, saint)
Update an existing saint

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **id** | [****](.md)| ID of saint to update | 
  **saint** | [**Saint**](Saint.md)| Saint object that needs to be added to the database | 

### Return type

[**models::Saint**](Saint.md)

### Authorization

[saint_auth](../README.md#saint_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)