POST {version}/GetDeposits

Get Deposits

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

Query

Name	Description	Type	Additional information
ActiveOnly		boolean	None.
Ids		Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "ActiveOnly": true,
  "Ids": [
    "684985b2-dc36-4a13-92e3-c3fc214d66e0",
    "5a625f3c-c423-468a-9012-b9086279e0ef"
  ]
}

application/xml, text/xml

Sample:

<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <ActiveOnly>true</ActiveOnly>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>684985b2-dc36-4a13-92e3-c3fc214d66e0</d2p1:guid>
    <d2p1:guid>5a625f3c-c423-468a-9012-b9086279e0ef</d2p1:guid>
  </Ids>
</Query>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Deposits

Collection of Deposit

Name	Type	Additional information
GUID	globally unique identifier	None.
ID	integer	None.
Name	string	None.
Date	date	None.
DisplayDate	string	None.
Display	string	None.
Total	decimal number	None.
Deleted	boolean	None.
CreatedOn	date	None.
CreatedBy	globally unique identifier	None.
UpdatedOn	date	None.
UpdatedBy	globally unique identifier	None.
DeletedOn	date	None.
DeletedBy	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GUID": "31dd0d92-28b5-46f7-82d3-e4358a810655",
    "ID": 2,
    "Name": "sample string 3",
    "Date": "10/16/2024",
    "DisplayDate": "10/16/2024",
    "Display": "2-sample string 3 (10/16/2024)",
    "Total": 1.0,
    "Deleted": true,
    "CreatedOn": "10/16/2024",
    "CreatedBy": "65f9ca98-36b0-469e-a846-45d1874ee063",
    "UpdatedOn": "10/16/2024",
    "UpdatedBy": "62e5c370-f83e-4470-8229-a596aef6fb8c",
    "DeletedOn": "10/16/2024",
    "DeletedBy": "a3341b01-499f-4927-97c8-89e7d978da4a"
  },
  {
    "GUID": "31dd0d92-28b5-46f7-82d3-e4358a810655",
    "ID": 2,
    "Name": "sample string 3",
    "Date": "10/16/2024",
    "DisplayDate": "10/16/2024",
    "Display": "2-sample string 3 (10/16/2024)",
    "Total": 1.0,
    "Deleted": true,
    "CreatedOn": "10/16/2024",
    "CreatedBy": "65f9ca98-36b0-469e-a846-45d1874ee063",
    "UpdatedOn": "10/16/2024",
    "UpdatedBy": "62e5c370-f83e-4470-8229-a596aef6fb8c",
    "DeletedOn": "10/16/2024",
    "DeletedBy": "a3341b01-499f-4927-97c8-89e7d978da4a"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDeposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Deposit>
    <CreatedBy>65f9ca98-36b0-469e-a846-45d1874ee063</CreatedBy>
    <CreatedOn>2024-10-16T12:25:54.2143772-04:00</CreatedOn>
    <Date>2024-10-16T12:25:54.2143772-04:00</Date>
    <Deleted>true</Deleted>
    <DeletedBy>a3341b01-499f-4927-97c8-89e7d978da4a</DeletedBy>
    <DeletedOn>2024-10-16T12:25:54.2143772-04:00</DeletedOn>
    <GUID>31dd0d92-28b5-46f7-82d3-e4358a810655</GUID>
    <ID>2</ID>
    <Name>sample string 3</Name>
    <Total>1</Total>
    <UpdatedBy>62e5c370-f83e-4470-8229-a596aef6fb8c</UpdatedBy>
    <UpdatedOn>2024-10-16T12:25:54.2143772-04:00</UpdatedOn>
  </Deposit>
  <Deposit>
    <CreatedBy>65f9ca98-36b0-469e-a846-45d1874ee063</CreatedBy>
    <CreatedOn>2024-10-16T12:25:54.2143772-04:00</CreatedOn>
    <Date>2024-10-16T12:25:54.2143772-04:00</Date>
    <Deleted>true</Deleted>
    <DeletedBy>a3341b01-499f-4927-97c8-89e7d978da4a</DeletedBy>
    <DeletedOn>2024-10-16T12:25:54.2143772-04:00</DeletedOn>
    <GUID>31dd0d92-28b5-46f7-82d3-e4358a810655</GUID>
    <ID>2</ID>
    <Name>sample string 3</Name>
    <Total>1</Total>
    <UpdatedBy>62e5c370-f83e-4470-8229-a596aef6fb8c</UpdatedBy>
    <UpdatedOn>2024-10-16T12:25:54.2143772-04:00</UpdatedOn>
  </Deposit>
</ArrayOfDeposit>