Retrieves constraints based on query parameters.

GET 
/Constraints

Retrieves constraints based on query parameters.

Request

Query Parameters

defendantCustomerCode string

Defendant customer code

status ConstraintStatus

Possible values: [Pending, AuditCompleted, FullySettled, PartiallySettled, Deleted]

Constraint status

page int32

Default value: 1

Page number

pageSize int32

Default value: 20

Page size

api-version string

Header Parameters

X-Request-ID stringrequired

Responses

200

List of constraints if found, otherwise an error response

application/json

Schema

Schema

items object[]nullable
Array [
constraintCode stringnullablerequired
constraintIncomingType stringnullablerequired
constraintKind stringnullablerequired
constraintType stringnullablerequired
constraintDescription stringnullablerequired
protocolNumber stringnullablerequired
protocolNumberDate date-timerequired
constraintAmount decimalrequired
constraintPercentage decimalrequired
constraintStatus object nullable
oneOf
ConstraintStatus
string
Possible values: [Pending, AuditCompleted, FullySettled, PartiallySettled, Deleted]
ordererPreview object nullable
oneOf
OrdererPreview
tin stringnullablerequired
name stringnullablerequired
type stringnullablerequired
]
totalItemsCount int32required

Example (from schema)

{
  "items": [
    {
      "constraintCode": "string",
      "constraintIncomingType": "string",
      "constraintKind": "string",
      "constraintType": "string",
      "constraintDescription": "string",
      "protocolNumber": "string",
      "protocolNumberDate": "2024-07-29T15:51:28.071Z",
      "constraintAmount": 0,
      "constraintPercentage": 0,
      "constraintStatus": "Pending",
      "ordererPreview": {}
    }
  ],
  "totalItemsCount": 0
}

400

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...