Partners (REST API)

You can search, add, modify and delete Partners via HTTP.

Logs for requests of this kind can be found in the "Server logging" (→ "Administration") under internal/message.log.

Find a partner

Via the Partner overview, its ID is returned.

URL (HTTP GET):

Example response

The structure of the response is identical for each successful partner operation.

The id is in the Partner overview.

{
    "response": {
        "status": "ok",
        "id": "1554894544117000"
    }
}

Adding a partner

URL (HTTP POST with JSON):

{
	"operation": "add",
	"id": 0,
	"name": "My partner",
	"active": true
}

You can either specify 0 for the id or omit the line altogether, since the ID (see Partner overview) will be generated during this operation.

The name parameter specifies the name of the partner to be created.

The active parameter allows you to set the partner as active or inactive.

Updating a partner

URL (HTTP POST with JSON):

NOTE:   You can also use the name of the partner instead of the ID of the partner as value for parameter id.

{
    "operation": "update",
    "id": 1616381046459001,
	"name": "My partner updated",
	"active": false
}

Deleting a partner

URL (HTTP POST with JSON):

NOTE:   You can also use the name of the partner instead of the ID of the partner as value for the id parameter.

{
    "operation": "delete",
    "id": 1616381046459001
}

Logs

Logs for requests of this kind can be found in the "Server logging" (→ "Administration") under internal /message.log (or in file./logs/services/message.log).