Versions Compared

Old Version 2

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 3

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

An update request is a JSON object to create, update or delete a person.

Deleting a person

The payload’s properties are:

action

Value: Delete

string, Mandatory

cid

The company ID of the person. You need to specify this value.

int, Mandatory

pid, login, email

Use any of these three properties to uniquely identify the person to delete. The system will select in this order of priority: pid, then login, then email.

  • pid: The unique person ID. An integer.

  • login: The login of the person. This only works if the person actually was assigned a login in the first place.

  • email: The email of the person. Please note that Wordbee does not enforce unique emails!

Examples:

Code Block
{ "pid": 1000 }
or
{ "login": "john.hauser" }
or
{ "email": "john@hauser.me" }

int?, string?, string?

Mandatory

data

An optional free-text information. It will be returned with the results for your convenience.

string, Optional

Example:

Code Block
{
    "action": "Delete",
    "pid": 677,
    "cid": 537,
    "data": "just a test"
}

Deleting a person

The JSON properties are:

action

Either one of:

  • Create: To create a new person.

  • Update: To update an existing person.

  • Delete: To delete an existing person.

  • ChangeOrCreate: To update the person if it exists, or otherwise to create a new person.

  • Skip: Disregard this request. With this option, no other property is mandatory.

string, Mandatory

cid

Company ID. This property is mandatory. You do indeed need to find out the company to which the person is attached or shall be attached.

By the way, it is not possible to change the company ID of an existing person. Once a person is attached to a company, this attachment is forever!

int, Mandatory

pid

The unique ID of the person. When deleting or updating a person you need to provide any of the 3 possible identifiers: Id, Login, Email.

int?, Optional

login

The login assigned to the person. When deleting or updating a person you need to provide any of the 3 possible identifiers: Id, Login, Email.

The login is not mandatory and a person without a login is perfectly valid in Wordbee Translator.

string, Optional

email

The email. When creating a new person you must specify the email.

string, Optional