Corporate compliance

Method: Error word list

Authorization is required. If an error word is found during the content creation process, it will abort it with a validation error message.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/compliance/error-word/list/{groupId}

Parameters

propertyvaluedescription
groupId guid The group's id for which you request the error word list

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Eu sit fugiat sit incididunt ex ad esse labore nulla cillum culpa.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": {},
  "object": {
    "offset": 0,
    "words": [
      {
        "name": "proident",
        "type": "errorWord",
        "group": {
          "id": "1aeef766-52d1-4e7c-b8ca-9c9d9bf3f083",
          "name": "exercitation",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        }
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
name string the name represents the string that will be matched when the content is created. If it is found, the content creation process will fail.
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)

Method: Error word create

Authorization is required. If an error word is found during the content creation process, it will abort it with a validation error message.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/compliance/error-word

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string The lookup string that you want to prevent users from creating the content

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    }
  ],
  "object": {
    "name": "1proident",
    "type": "errorWord",
    "group": {
      "id": "1aeef766-52d1-4e7c-b8ca-9c9d9bf3f083",
      "name": "exercitation",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

groupobjectSome common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)

propertyvaluedescription
name string the name represents the string that will be matched when the content is created. If it is found, the content creation process will fail.

Method: Error word update

Authorization is required. If an error word is found during the content creation process, it will abort it with a validation error message.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/compliance/error-word/{oldName}

Parameters

propertyvaluedescription
oldName string The old string that you need to change

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string The new string that you want to be looked up and if found to prevent the content creation.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    }
  ],
  "object": {
    "name": "1proident",
    "type": "errorWord",
    "group": {
      "id": "1aeef766-52d1-4e7c-b8ca-9c9d9bf3f083",
      "name": "exercitation",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

groupobjectSome common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)

propertyvaluedescription
name string the name represents the string that will be matched when the content is created. If it is found, the content creation process will fail.

Method: Error word delete

Authorization is required. If an error word is found during the content creation process, it will abort it with a validation error message.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/compliance/error-word/{name}/group/{group}

Parameters

propertyvaluedescription
name string The lookup string that you want to prevent users from creating the content
groupId guid In which group to create the record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    }
  ],
  "object": {
    "name": "1proident",
    "type": "errorWord",
    "group": {
      "id": "1aeef766-52d1-4e7c-b8ca-9c9d9bf3f083",
      "name": "exercitation",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted

Method: Warning word list

Authorization is required. The warning words will not prevent the content to be created, but have the ability to warn the user with a custom message.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/compliance/warning-word/list/{groupId}

Parameters

propertyvaluedescription
groupId guid The group's id for which you request the error word list

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Elit dolore in officia in esse in minim occaecat amet occaecat cillum minim.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": {},
  "object": {
    "offset": 0,
    "words": [
      {
        "name": "sint",
        "type": "warningWord",
        "group": {
          "id": "d9aa3090-24cf-4578-b426-8de5da61840b",
          "name": "non",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "showMessage": false,
        "message": "Adipisicing tempor anim minim cillum irure aute nostrud mollit veniam.",
        "showCount": 1
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
name string the name represents the string that will be matched when the content is created. If it is found, the content creation process will fail.
group object Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page)
showMessage boolean Whether to show a warning message when such a word is found.
message string the warning message text
showCount integer how many times to show the warning message

Method: Warning word create

Authorization is required. The warning words will not prevent the content to be created, but have the ability to warn the user with a custom message.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/compliance/warning-word

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string The lookup string that you want to prevent users from creating the content
showMessage boolean Whether to show a warning message when such a word is found.
message string the warning message text
showCount integer how many times to show the warning message

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Already included as error word"
    }
  ],
  "object": {
    "name": "1veniam",
    "type": "warningWord",
    "group": {
      "id": "70717d6a-897c-4e79-8c9b-62f345cd90c3",
      "name": "nostrud",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "showMessage": false,
    "message": "Ea in fugiat aliquip cillum in minim enim in voluptate excepteur.",
    "showCount": 1
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: Warning word update

Authorization is required. The warning words will not prevent the content to be created, but have the ability to warn the user with a custom message.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/compliance/warning-word/{oldName}

Parameters

propertyvaluedescription
oldName string The lookup string you need changed

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string The new lookup string that you want to prevent users from creating the content
showMessage boolean Whether to show a warning message when such a word is found.
message string the warning message text
showCount integer how many times to show the warning message

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Already included as error word"
    }
  ],
  "object": {
    "name": "1veniam",
    "type": "warningWord",
    "group": {
      "id": "70717d6a-897c-4e79-8c9b-62f345cd90c3",
      "name": "nostrud",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "showMessage": false,
    "message": "Ea in fugiat aliquip cillum in minim enim in voluptate excepteur.",
    "showCount": 1
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: Warning word delete

Authorization is required. The warning words will not prevent the content to be created, but have the ability to warn the user with a custom message.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/compliance/warning-word/{name}/group/{groupId}

Parameters

propertyvaluedescription
name string The lookup string that you want to prevent users from creating the content
groupId guid In which group to create the record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "name",
      "value": "",
      "message": "Already included as error word"
    }
  ],
  "object": {
    "name": "1veniam",
    "type": "warningWord",
    "group": {
      "id": "70717d6a-897c-4e79-8c9b-62f345cd90c3",
      "name": "nostrud",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "showMessage": false,
    "message": "Ea in fugiat aliquip cillum in minim enim in voluptate excepteur.",
    "showCount": 1
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted