Transparency

peopleTransparency

post

Request to create or update transparency actions related to a pguid

Body

application/json

Responses

201

Created

application/json

statusstringOptional

transaction status.

202

Updated

application/json

400

Validation Error

application/json

500

Internal error

application/json

post/people-transparency

HTTPcURLJavaScriptPython

POST /gbds/v2/people-transparency HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "data": {
    "pguid": "text",
    "action": "NOTIFY",
    "enabled": "text",
    "groups": [
      {}
    ]
  }
}

{
  "status": "text",
  "data": {
    "pguid": "text",
    "action": "NOTIFY",
    "enabled": "text",
    "groups": [
      {}
    ]
  }
}

getPeopleTransparency

get

Request to get people transparency information by pguid.

Path parameters

pguidstringRequired

Global unique ID of the person.

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal error

application/json

get/people-transparency/{pguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/people-transparency/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": [
    {
      "pguid": "text",
      "action": "NOTIFY",
      "enabled": "text",
      "groups": [
        {}
      ]
    }
  ]
}

deletePeopleTransparency

delete

this method deletes a given pguid from people transparency.

Path parameters

pguidstringRequired

Global unique ID of the person.

Query parameters

actionstringOptional

transparency action

Responses

204

Deleted

application/json

objectOptional

400

Validation Error

application/json

500

Internal error

application/json

delete/people-transparency/{pguid}

HTTPcURLJavaScriptPython

DELETE /gbds/v2/people-transparency/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

getTransparencyList

get

Get people transparency list.

Query parameters

pageIndexinteger · int32Optional

Defines which page will be returned.

pageSizeinteger · int32Optional

Size of the request.

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal error

application/json

get/people-transparency/list

HTTPcURLJavaScriptPython

GET /gbds/v2/people-transparency/list HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": [
    {
      "pguid": "text",
      "action": "NOTIFY",
      "enabled": "text",
      "groups": [
        {}
      ]
    }
  ]
}