MyCSI API - Documentation

GET LeaseInProcess/Assets/{id}

Method used to fetch a collection of Lease In Process Assets.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Security token provided via the Authentication method.

 globally unique identifier

Required

Body Parameters

Objects used to page through the collection of Leases In Process Assets, as well as filter the returned objects.

LeaseInProcessAssetFilterModel
NameDescriptionTypeAdditional information
Address

Optional, Address of the Lease In Process Asset.

 string

None.
CustomerReference

Optional, CustomerReference of the Lease In Process Asset.

 string

None.
LastUpdated

Optional, filter Assets based on the last time they were updated. For example, if '2017-01-01' was used, all of the assets modified on and since the first of January 2017 would be returned.

 date

None.
Lease

Optional, Lease to which the Lease In Process Asset belongs.

 string

None.
LessorCountryCode

Optional, country code of the Lessor to which the Lease In Process Asset belongs.

 string

None.
Manufacturer

Optional, Manufacturer of the Lease In Process Asset.

 string

None.
Model

Optional, Model of the Lease In Process Asset.

 string

None.
PageNumber

Optional, the number of the current 'page' of items returned during the API request.

 integer

None.
PageSize

Optional, number of items in the 'page' returned during the API request.

 integer

None.
Schedule

Optional, Schedule to which the Lease In Process Asset belongs.

 string

None.
Serial

Optional, Serial Number of the Lease In Process Asset.

 string

None.
SiteCity

Optional, SiteCity of the Lease In Process Asset.

 string

None.
State

Optional, State of the Lease In Process Asset.

 string

None.
Zip

Optional, Zip of the Lease In Process Asset.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Lease": "sample string 1",
  "Schedule": "sample string 2",
  "LessorCountryCode": "sample string 3",
  "Serial": "sample string 4",
  "Manufacturer": "sample string 5",
  "Model": "sample string 6",
  "CustomerReference": "sample string 7",
  "Address": "sample string 8",
  "SiteCity": "sample string 9",
  "State": "sample string 10",
  "Zip": "sample string 11",
  "LastUpdated": "2025-05-03T11:35:22.0834661-05:00",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample: 
{"Lease":"sample string 1","Schedule":"sample string 2","LessorCountryCode":"sample string 3","Serial":"sample string 4","Manufacturer":"sample string 5","Model":"sample string 6","CustomerReference":"sample string 7","Address":"sample string 8","SiteCity":"sample string 9","State":"sample string 10","Zip":"sample string 11","LastUpdated":"2025-05-03T11:35:22.0834661-05:00","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample: 
<LeaseInProcessAssetFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Filters">
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <Address>sample string 8</Address>
  <CustomerReference>sample string 7</CustomerReference>
  <LastUpdated>2025-05-03T11:35:22.0834661-05:00</LastUpdated>
  <Lease>sample string 1</Lease>
  <LessorCountryCode>sample string 3</LessorCountryCode>
  <Manufacturer>sample string 5</Manufacturer>
  <Model>sample string 6</Model>
  <Schedule>sample string 2</Schedule>
  <Serial>sample string 4</Serial>
  <SiteCity>sample string 9</SiteCity>
  <State>sample string 10</State>
  <Zip>sample string 11</Zip>
</LeaseInProcessAssetFilterModel>

application/x-www-form-urlencoded

Sample: 
?Lease=SampleString1&Schedule=SampleString2&LessorCountryCode=SampleString3&Serial=SampleString4&Manufacturer=SampleString5&Model=SampleString6&CustomerReference=SampleString7&Address=SampleString8&SiteCity=SampleString9&State=SampleString10&Zip=SampleString11&LastUpdated=2025-05-03&PageNumber=1&PageSize=1

Response Information

Resource Description

The LeaseInProcessAssetModel object, containing the collection of Leases In Process Assets.

LeaseInProcessAssetModel
NameDescriptionTypeAdditional information
ErrorMessage

Optional error message provided by the method call.

 string

None.
LeaseInProcessAssets

Collection of Lease In Process Assets being returned.

 Collection of LeaseInProcessAsset

None.
Message

Optional message provided by the method call.

 string

None.
Paging

Contains information relevant to paging through a collection of objects.

 PagingModel

None.
StatusCode

The HTTP Status Code of the method call.

 HttpStatusCode

None.
Success

Boolean flag indicating the success or failure of the method call.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "LeaseInProcessAssets": [
    {
      "ID": 1,
      "Lease": "sample string 2",
      "Schedule": "sample string 3",
      "LessorCountryCode": "sample string 4",
      "CustomerName": "sample string 5",
      "SerialNumber": "sample string 6",
      "Manufacturer": "sample string 7",
      "Model": "sample string 8",
      "CustomerReference": "sample string 9",
      "Address": "sample string 10",
      "SiteCity": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "AnticipatedTermStart": "2025-05-03T11:35:22.0834661-05:00",
      "LastModified": "2025-05-03T11:35:22.0834661-05:00",
      "InventoryId": 1
    },
    {
      "ID": 1,
      "Lease": "sample string 2",
      "Schedule": "sample string 3",
      "LessorCountryCode": "sample string 4",
      "CustomerName": "sample string 5",
      "SerialNumber": "sample string 6",
      "Manufacturer": "sample string 7",
      "Model": "sample string 8",
      "CustomerReference": "sample string 9",
      "Address": "sample string 10",
      "SiteCity": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "AnticipatedTermStart": "2025-05-03T11:35:22.0834661-05:00",
      "LastModified": "2025-05-03T11:35:22.0834661-05:00",
      "InventoryId": 1
    }
  ],
  "Paging": {
    "PageSize": 1,
    "PageNumber": 2,
    "TotalPages": 3,
    "TotalItems": 4
  },
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": "sample string 3",
  "StatusCode": 100
}

application/octet-stream

Sample: 
{"LeaseInProcessAssets":[{"ID":1,"Lease":"sample string 2","Schedule":"sample string 3","LessorCountryCode":"sample string 4","CustomerName":"sample string 5","SerialNumber":"sample string 6","Manufacturer":"sample string 7","Model":"sample string 8","CustomerReference":"sample string 9","Address":"sample string 10","SiteCity":"sample string 11","State":"sample string 12","Zip":"sample string 13","AnticipatedTermStart":"2025-05-03T11:35:22.0834661-05:00","LastModified":"2025-05-03T11:35:22.0834661-05:00","InventoryId":1},{"ID":1,"Lease":"sample string 2","Schedule":"sample string 3","LessorCountryCode":"sample string 4","CustomerName":"sample string 5","SerialNumber":"sample string 6","Manufacturer":"sample string 7","Model":"sample string 8","CustomerReference":"sample string 9","Address":"sample string 10","SiteCity":"sample string 11","State":"sample string 12","Zip":"sample string 13","AnticipatedTermStart":"2025-05-03T11:35:22.0834661-05:00","LastModified":"2025-05-03T11:35:22.0834661-05:00","InventoryId":1}],"Paging":{"PageSize":1,"PageNumber":2,"TotalPages":3,"TotalItems":4},"Success":true,"Message":"sample string 2","ErrorMessage":"sample string 3","StatusCode":100}

application/xml, text/xml

Sample: 
<LeaseInProcessAssetModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 3</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 2</Message>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">Continue</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">true</Success>
  <Paging xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">
    <PageNumber>2</PageNumber>
    <PageSize>1</PageSize>
    <TotalItems>4</TotalItems>
    <TotalPages>3</TotalPages>
  </Paging>
  <LeaseInProcessAssets>
    <LeaseInProcessAsset>
      <Address>sample string 10</Address>
      <AnticipatedTermStart>2025-05-03T11:35:22.0834661-05:00</AnticipatedTermStart>
      <CustomerName>sample string 5</CustomerName>
      <CustomerReference>sample string 9</CustomerReference>
      <ID>1</ID>
      <InventoryId>1</InventoryId>
      <LastModified>2025-05-03T11:35:22.0834661-05:00</LastModified>
      <Lease>sample string 2</Lease>
      <LessorCountryCode>sample string 4</LessorCountryCode>
      <Manufacturer>sample string 7</Manufacturer>
      <Model>sample string 8</Model>
      <Schedule>sample string 3</Schedule>
      <SerialNumber>sample string 6</SerialNumber>
      <SiteCity>sample string 11</SiteCity>
      <State>sample string 12</State>
      <Zip>sample string 13</Zip>
    </LeaseInProcessAsset>
    <LeaseInProcessAsset>
      <Address>sample string 10</Address>
      <AnticipatedTermStart>2025-05-03T11:35:22.0834661-05:00</AnticipatedTermStart>
      <CustomerName>sample string 5</CustomerName>
      <CustomerReference>sample string 9</CustomerReference>
      <ID>1</ID>
      <InventoryId>1</InventoryId>
      <LastModified>2025-05-03T11:35:22.0834661-05:00</LastModified>
      <Lease>sample string 2</Lease>
      <LessorCountryCode>sample string 4</LessorCountryCode>
      <Manufacturer>sample string 7</Manufacturer>
      <Model>sample string 8</Model>
      <Schedule>sample string 3</Schedule>
      <SerialNumber>sample string 6</SerialNumber>
      <SiteCity>sample string 11</SiteCity>
      <State>sample string 12</State>
      <Zip>sample string 13</Zip>
    </LeaseInProcessAsset>
  </LeaseInProcessAssets>
</LeaseInProcessAssetModel>