All URIs are relative to https://radiomanager.io/api/v2
Method | HTTP request | Description |
---|---|---|
CreateContact | Post /contacts | Create contact. |
DeleteContactById | Delete /contacts/{id} | Delete contact by id |
GetContactById | Get /contacts/{id} | Get contact by id |
ListContacts | Get /contacts | Get all contacts. |
UpdateContactByID | Patch /contacts/{id} | Update contact by id |
PostSuccess CreateContact(ctx, data) Create contact.
Create contact.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
data | ContactDataInput | Data (Required) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Success DeleteContactById(ctx, id) Delete contact by id
Delete contact by id
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int64 | ID of Contact (Required) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ContactResult GetContactById(ctx, id, optional) Get contact by id
Get contact by id
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int64 | ID of Contact (Required) | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int64 | ID of Contact (Required) | |
externalStationId | int64 | Query on a different (content providing) station (Optional) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ContactResults ListContacts(ctx, optional) Get all contacts.
List all contacts.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
page | int64 | Current page (Optional) | [default to 1] |
itemId | int64 | Search on Item ID (Optional) `(Relation)` | |
modelTypeId | int64 | Search on ModelType ID (Optional) `(Relation)` | |
tagId | int64 | Search on Tag ID (Optional) `(Relation)` | |
limit | int64 | Results per page (Optional) | |
orderBy | string | Field to order the results (Optional) | |
orderDirection | string | Direction of ordering (Optional) | |
externalStationId | int64 | Query on a different (content providing) station (Optional) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Success UpdateContactByID(ctx, id, optional) Update contact by id
Update contact by id
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int64 | ID of Contact (Required) | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int64 | ID of Contact (Required) | |
data | ContactDataInput | Data (Optional) |
[API Key](../README.md#API Key)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]