Setting up and testing terms conditions messages API

Use the settings described in the topic below to set up and test the terms conditions messages API. The following fields on the Terms Conditions and Messages determine the settings if the message is displayed on the screen. See Creating terms, conditions and messages.

Show content to Agent: If this check box is selected, the message is displayed by the system as a pop-up on the screen. You can click OK on the message pop-up.
Show Content with Acknowledge: If this check box is selected, the message is displayed by the system as a pop-up on the screen. You can Accept or Decline the pop-up message.
Save Agent Acknowledge: You can select this check box only when the Show Content with Acknowledge is selected.
Publish to Partners:If this check box is selected, the record is sent to the partners who subscribe to the pub/sub.
Publish on Reservation: If this check box is selected, the code is sent to CRM to be printed on the confirmation and on the rental agreement.

To set up and test terms conditions messages API:

Select Administration > Configuration > Terms Conditions and Messages.
Set up the terms conditions and messages. See Creating terms, conditions and messages.
Select Administrator > Databridge > -> Databridge Partner .
Click New Record.
Specify this information:

Partner

Select RESQA1 as the partner. Also specify the partner description as ResQA1.

Partner ID

Specify the ID code by which to identify the RESQA1 partner in the business documents exchanged with the partner.

Active

Select to indicate that the Databridge partner is active. If this check box is clear, no events are sent to the partner.

Default Location

Specify the default location associated with the partner. This is not mandatory. Even if you do not specify any location, the outbound is still generated.

Databridge Login

Specify the User ID and Password that you will use in Postman to authenticate. For example, User ID as ResQA1 and Password as TEST123

Infor ResRent User ID

Enter the user ID code identifying the ResRent user. For example, R5.

Infor ResRent Password

Enter the password for the ResRent user.

First Method - Configure the Postman request using complex find for unknown terms and services: Send the parameters.

TYPE: POST
API URL: http://localhost/api/terms/find. For example http://usea1wresrent1/api/terms/find
Authorization tab:
- Type : OAuth1.0
- Consumer key: The value you configured as the databridge partner Ex: RESQA1
- Consumer Secret: The password you configured as the databridge partner password: Ex: TEST123
Header Tab:
- Key: Tenant Value: RES_QA1
- Key: Content-Type Value: application/json

Body Tab: Sample Request data

{
"type":"BP",
"brand":"ZR",
"lang":"EN",
"reservationDate":"2019-03-11T11:00:00",
"country":"IT",
"region":"EMEA",
"location":"MCOT01ZE",
"channel":"RES",
"conditions": {
"AAO":"+",
"AGE":"18",  
"CCR":"+",
"RND":"+",
"RTYPE":["MM","FBO"] 
}
}

Sample Response

{
"success": true,
"terms": [
{ "id": "4", "code": "BOTTOMPANE", "lang": "EN", "description": "bottom pane", "type": "BP", "text": "<html>Bottom pane message- Andi </html>", "showContent": false, "showContentWAck": false, "saveAgentAck": false, "publishOnRes": false }
,
{ "id": "5", "code": "BPAGE18", "lang": "EN", "description": "bottom pane", "type": "BP", "text": "<html>REnter is 18-19</html>", "category": "AGE", "categoryValue": "18", "showContent": false, "showContentWAck": false, "saveAgentAck": false, "publishOnRes": false }
,
{ "id": "9", "code": "BPPUB", "lang": "EN", "description": "TESTPUBLISH", "type": "BP", "text": "<html>test for publishing </html>", "showContent": false, "showContentWAck": false, "saveAgentAck": false, "publishOnRes": false }
,
{ "id": "7", "code": "RTYPE", "lang": "EN", "description": "reservation type", "type": "BP", "text": "<html>Reservation type of FBO</html>", "category": "RTYPE", "categoryValue": "FBO", "showContent": false, "showContentWAck": false, "saveAgentAck": false, "publishOnRes": false }
,
{ "id": "8", "code": "RTYPE2", "lang": "EN", "description": "reservation type", "type": "BP", "text": "<html>Reservation type of MM</html>", "category": "RTYPE", "categoryValue": "MM", "showContent": false, "showContentWAck": false, "saveAgentAck": false, "publishOnRes": false }
]
}

Alternatively, Second Method - Configure the Postman request using Complex find method: Must know the Terms and Condition IDs.

TYPE: POST
API URL: http://localhost/api/terms/find. For example http://usea1wresrent1/api/terms/find
Authorization tab:
- Type : OAuth1.0
- Consumer key: The value you configured as the databridge partner Ex: RESQA1
- Consumer Secret: The password you configured as the databridge partner password: Ex: TEST123
Header Tab:
- Key: Tenant Value: RES_QA1
- Key: Content-Type Value: application/json

Body Tab: Sample Request data

{
	"ids":["25","26"],
	"type":"TC"
}

Sample Response

{
    "success": true,
    "terms": [
        {
            "id": "25",
            "code": "SHOWCONTENT",
            "lang": "EN",
            "description": "Show content only",
            "type": "TC",
            "text": "<html>SHOW CONTENT TO AGENT IS CHECKED ONLY- WILL ONLY SEE OK BUTTON&nbsp;</html>",
            "showContent": true,
            "showContentWAck": false,
            "saveAgentAck": false,
            "publishOnRes": false
        },
        {
            "id": "26",
            "code": "SHOWWITHACK",
            "lang": "EN",
            "description": "Show WITH ACK",
            "type": "TC",
            "text": "<html>SHOW CONTENT WITH ACKNOWLEDGE IS CHECKED ONLY- WILL ONLY SEE ACCEPT AND DECLINE BUTTON&nbsp;</html>",
            "showContent": false,
            "showContentWAck": true,
            "saveAgentAck": false,
            "publishOnRes": false
        }
    ]
}