API docs by Redocly

Aptic API Gateway - Collaterals (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Collateral related API for Aptic solutions

Collaterals

Get collaterals

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Get specific collateral

Authorizations:
(oauth2apikey)
path Parameters
collateralGuid
required
string

Collateral guid

Responses

Response samples

Content type
{
  • "collateralGuid": "string",
  • "pledgeType": 0,
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ],
  • "links": [
    ]
}

Updates a collateral

Authorizations:
(oauth2apikey)
path Parameters
collateralGuid
required
string

Collateral guid

Request Body schema:

Collateral information

referenceNumber
string or null

Reference or identification number for pledge

pledgeDate
string or null <date-time>

Pledge date

pledgeAmount
number or null <double>

Pledge amount

description
string or null

Description of the pledge

note
string or null

Notes for this pledge

insurer
string or null

Insurer for this pledge

insuranceNumber
string or null

Insurance number for this pledge

insuredAmount
number or null <double>

Insured amount for this pledge

insuranceExpiryDate
string or null <date-time>

Expiry date of the insurance for this pledge

realized
boolean or null

The collateral has been sold/realized

object (AccountCollateralFixedAsset)

Fixed asset information

object (AccountCollateralMovableproperty)

Movable property information

object (AccountCollateralCompanyMortgage)

Company mortgage information

object (AccountCollateralSeizure)

Seizure information

Array of objects or null (LienpriorityElm)

All known mortgage lien priorities

Array of objects or null (OwnerElm)

Land certificates (only valid when PledgeType = 1)

Responses

Request samples

Content type
{
  • "referenceNumber": "string",
  • "pledgeDate": "2019-08-24T14:15:22Z",
  • "pledgeAmount": 0,
  • "description": "string",
  • "note": "string",
  • "insurer": "string",
  • "insuranceNumber": "string",
  • "insuredAmount": 0,
  • "insuranceExpiryDate": "2019-08-24T14:15:22Z",
  • "realized": true,
  • "fixedAsset": {
    },
  • "movableproperty": {
    },
  • "companyMortgage": {
    },
  • "seizure": {
    },
  • "lienPriorities": [
    ],
  • "landCertificates": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a collateral

Authorizations:
(oauth2apikey)
path Parameters
collateralGuid
required
string

Collateral guid

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Collateral guid

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }