user.agreement.find

The user.agreement.find command is used to find a user agreement.

TR50 Request

{
  "cmd": {
    "command": "user.agreement.find",
    "params": {
      "id": "56fd32f592865abd578b456b"
    }
  }
}

Request Parameters

Name	Type	Required	Description
id	String	Yes	The unique identifier of the agreement.

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.

TR50 Response

{
  "cmd": {
    "success": true,
    "params":{
      "id": "56fd32f592865abd578b456b",
      "body": "The body of the agreement", 
      "name": "Terms of Service", 
      "desc": "A description of the agreement",
      "createdBy": "admin@example.com",
      "createdOn": "2018-10-15T09:00:00.000Z",
      "updatedBy": "admin@example.com",
      "updatedOn": "2018-10-15T09:00:00.000Z"
    }
  }
}

Response Result Parameters

Name	Type	Description
id	String	The unique identifier of the agreement.
body	String	The body text of the agreement
name	String	The name of the agreement
desc	String	An optional description of the agreement
createdBy	String	The user who created the user agreement
createdOn	String	The date the user agreement was created
updatedBy	String	The user who last modified the user agreement
updatedOn	String	The date the user agreement was last modified