Przejdź do głównej zawartości
Wersja: Stable

Manage consents

YetiForce API for Webservice App. Type: Manage consents (0.2)

Download OpenAPI specification:Download

Skip the /webservice fragment for connections via ApiProxy. There are two ways to connect to API, with or without rewrite, below are examples of both:

  • rewrite
    • CRM_URL/webservice/ManageConsents/Users/Login
    • CRM_URL/webservice/ManageConsents/Accounts/RecordRelatedList/117/Contacts
  • without rewrite
    • CRM_URL/webservice.php?_container=ManageConsents&module=Users&action=Login
    • CRM_URL/webservice.php?_container=ManageConsents&module=Accounts&action=RecordRelatedList&record=117&param=Contacts

Base module

Gets the list of consents for specific entry

Gets consents.

Authorizations:
(basicAuthApiKeyAuthtoken)
path Parameters
moduleName
required
string
Example: Contacts

Module name

Request Body schema:
required

Required data for communication

token
string

Entry unique ID (Token type field in the module is required)

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "status": 0,
  • "result": {
    }
}

Send e-mail

Send e-mail.

Authorizations:
(basicAuthApiKeyAuthtoken)
path Parameters
moduleName
required
string
Example: Contacts

Module name

Request Body schema:
required

Required data for communication

e-mail
string

E-mail address (Token type field in the module is required)

templateId
integer

Specific ID of the email template

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "status": 0,
  • "result": true
}

Approvals register

Adds an consent entry

Add record.

Authorizations:
(basicAuthApiKeyAuthtoken)
Request Body schema:
required

Required data for communication

object (A list of fields required while creating an entry)

The list is based on fields in the Consent register module. Accepting or declining consent takes place based on the value in the approvals_register_status field.

Responses

Request samples

Content type
No sample

Response samples

Content type
{
  • "status": 0,
  • "result": {
    }
}

Approvals

Gets the list of consents

Gets consents.

Authorizations:
(basicAuthApiKeyAuthtoken)
header Parameters
x-row-limit
integer
Example: 1000

Get rows limit, default: 1000

x-row-offset
integer

Offset, default: 0

x-raw-data
integer
Enum: 0 1
Example: 1

Gets raw data

x-condition
object (Conditions)
Example: {"fieldName":"approvals_status","value":"PLL_ACTIVE","operator":"e"}

Conditions [Json format]

Responses

Response samples

Content type
{
  • "status": 0,
  • "result": {
    }
}