Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
extract
v1

Retrieve Party

get/api/v1/extract/parties/{id}/

Path parameters

idstring required

A unique integer value identifying this party.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

pkinteger
namestring required
typestring nullable
type_abbrstring nullable required
type_labelstring nullable
type_descriptionstring nullable
descriptionstring nullable

Example response

{
  "name": "name",
  "description": "description",
  "type_abbr": "type_abbr",
  "pk": 0,
  "type_label": "type_label",
  "type": "type",
  "type_description": "type_description"
}