POST 17.0/database/custodialschemedepositrequests/list

Description

Retrieve a list of Custodial Scheme Deposit Requests

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of CustodialSchemeDepositRequestsUpdate
Name Description Type Additional information
ID

integer

None.
TenancyID

integer

None.
AddedDate

date

None.
RequestedDate

date

None.
TenantAmount

decimal number

None.
TenantReceivedAmount

decimal number

None.
LandlordAmount

decimal number

None.
LandlordReceivedAmount

decimal number

None.
Status

byte

None.
StatusDate

date

None.
UserID

integer

None.
SiteID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:34",
    "requestedDate": "2025-01-09T20:34",
    "tenantAmount": 1.0,
    "tenantReceivedAmount": 1.0,
    "landlordAmount": 1.0,
    "landlordReceivedAmount": 1.0,
    "status": 64,
    "statusDate": "2025-01-09T20:34",
    "userID": 1,
    "siteID": 1
  },
  {
    "id": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:34",
    "requestedDate": "2025-01-09T20:34",
    "tenantAmount": 1.0,
    "tenantReceivedAmount": 1.0,
    "landlordAmount": 1.0,
    "landlordReceivedAmount": 1.0,
    "status": 64,
    "statusDate": "2025-01-09T20:34",
    "userID": 1,
    "siteID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfCustodialSchemeDepositRequestsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustodialSchemeDepositRequestsUpdate>
    <ID>1</ID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:34:03.0768988+00:00</AddedDate>
    <RequestedDate>2025-01-09T20:34:03.0768988+00:00</RequestedDate>
    <TenantAmount>1</TenantAmount>
    <TenantReceivedAmount>1</TenantReceivedAmount>
    <LandlordAmount>1</LandlordAmount>
    <LandlordReceivedAmount>1</LandlordReceivedAmount>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:34:03.0768988+00:00</StatusDate>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
  </CustodialSchemeDepositRequestsUpdate>
  <CustodialSchemeDepositRequestsUpdate>
    <ID>1</ID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:34:03.0768988+00:00</AddedDate>
    <RequestedDate>2025-01-09T20:34:03.0768988+00:00</RequestedDate>
    <TenantAmount>1</TenantAmount>
    <TenantReceivedAmount>1</TenantReceivedAmount>
    <LandlordAmount>1</LandlordAmount>
    <LandlordReceivedAmount>1</LandlordReceivedAmount>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:34:03.0768988+00:00</StatusDate>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
  </CustodialSchemeDepositRequestsUpdate>
</ArrayOfCustodialSchemeDepositRequestsUpdate>