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.

Searching partner

Via the name of a partner, its ID is returned.

URL (HTTP GET):

Example response

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

The id is the partner ID.

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

Adding 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 will be generated during this operation.

Parameter name specifies the name of the partner to be created.

Parameter active allows you to set the partner active or inactive.

Updating 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 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": "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).