Manage consents

• Base module
  • postGets the list of consents for specific entry
  • postSend e-mail
• Approvals register
  • postAdds an consent entry
• Approvals
  • getGets the list of consents

API docs by Redocly

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

Download OpenAPI specification:Download

Devs API Team: devs@yetiforce.com URL: https://yetiforce.com/ License: YetiForce Public License Terms of Service

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

Platform API Interactive Docs

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:

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

required

Required data for communication

token

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

Responses

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/ManageConsents/{moduleName}/GetConsentsForEntry

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/ManageConsents/{moduleName}/GetConsentsForEntry

Request samples

• Payload

Content type

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

No sample

Response samples

• 200

Content type

application/json

{

• "status": 0,
• "result": {

  • "id": 24842,
  • "consents": {

    • "property1": 24862,
    • "property2": 24862

    }

  }

}

Send e-mail

Send e-mail.

Authorizations:

(basicAuthApiKeyAuthtoken)

path Parameters

moduleName required

string Example: Contacts Module name

Request Body schema:

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

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

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/ManageConsents/{moduleName}/SendEmail

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/ManageConsents/{moduleName}/SendEmail

Request samples

• Payload

Content type

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

No sample

Response samples

• 200

Content type

application/json

{

• "status": 0,
• "result": true

}

Approvals register

Adds an consent entry

Add record.

Authorizations:

(basicAuthApiKeyAuthtoken)

Request Body schema:

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

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

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/ManageConsents/ApprovalsRegister/Record

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/ManageConsents/ApprovalsRegister/Record

Request samples

• Payload

Content type

multipart/form-dataapplication/x-www-form-urlencodedapplication/jsonmultipart/form-data

No sample

Response samples

• 200

Content type

application/jsonapplication/xmlapplication/json

{

• "status": 0,
• "result": {

  • "id": 24842,
  • "error": ""

  }

}

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

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/ManageConsents/Approvals/RecordsList

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/ManageConsents/Approvals/RecordsList

Response samples

• 200
• 401
• 403
• 405

Content type

application/jsonapplication/xmlapplication/json

{

• "status": 0,
• "result": {

  • "records": {

    • "24862": {

      • "id": 24862,
      • "name": "Consent for email",
      • "approvals_status": "Active",
      • "number": "N12",
      • "assigned_user_id": "Kowalski Adam",
      • "createdtime": "2019-10-07 08:32:38",
      • "modifiedtime": "2019-10-07 08:32:38",
      • "created_user_id": "Kowalski Adam",
      • "shownerid": "Kowalski Adam",
      • "description": "I confirm to have read.."

      }

    },
  • "rawData": {

    • "24862": {

      • "id": 24862,
      • "name": "Consent for email",
      • "approvals_status": "PLL_ACTIVE",
      • "number": "N12",
      • "assigned_user_id": 245,
      • "createdtime": "2019-10-07 08:32:38",
      • "modifiedtime": "2019-10-07 08:32:38",
      • "created_user_id": 245,
      • "shownerid": "Kowalski Adam",
      • "description": "I confirm to have read.."

      }

    },
  • "isMorePages": true

  }

}