POST api/account/nrlRetained

Get an overview of customer nrl accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The nrl retained filter data contract supplied with the request.

NrlRetainedFilterDataContract

Name	Description	Type	Additional information
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageNumber": 2
}

Response Information

Resource Description

The response returned after the operation completes.

NrlRetainedPagedDataContract

Name	Description	Type	Additional information
TotalAccountBalance	The total account balance value.	decimal number	None.
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of NrlRetainedDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalAccountBalance": 1.0,
  "TotalCount": 2,
  "CurrentCount": 3,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "GroupId": 2,
      "Name": "sample string 3",
      "Address": "sample string 4",
      "LandlordResidentStatus": [
        "sample string 1",
        "sample string 2"
      ],
      "NrlReference": [
        "sample string 1",
        "sample string 2"
      ],
      "AccountBalance": 5.0
    },
    {
      "Id": 1,
      "GroupId": 2,
      "Name": "sample string 3",
      "Address": "sample string 4",
      "LandlordResidentStatus": [
        "sample string 1",
        "sample string 2"
      ],
      "NrlReference": [
        "sample string 1",
        "sample string 2"
      ],
      "AccountBalance": 5.0
    }
  ]
}