MyCSI API - Documentation

GET LeaseInProcess/{id}

Method used to fetch a collection of Leases In Process.

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, as well as filter the returned objects.

LeaseInProcessFilterModel
NameDescriptionTypeAdditional information
CustomerName

Optional, Customer Name of the Lessor to which the Schedule belongs.

 string

None.
FirstDayOfInitialTermEnded

Optional, End Date for Initial Term Ended Date query of the Lease.

 string

None.
FirstDayOfInitialTermStarted

Optional, Start Date for Initial Term Ended Date query of the Lease.

 string

None.
InstallationStartDateEnded

Optional, End Date for Installation Start Date query of the Lease.

 string

None.
InstallationStartDateStarted

Optional, Start Date for Installation Start Date query of the Lease.

 string

None.
Lease

Optional, Lease No to which the Schedule belongs.

 string

None.
LessorCountryCode

Optional, country code of the Lessor to which the Schedule belongs.

 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.
ScheduleName

Optional, Schedule Name to which the Lease belongs.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerName": "sample string 1",
  "LessorCountryCode": "sample string 2",
  "Lease": "sample string 3",
  "ScheduleName": "sample string 4",
  "InstallationStartDateStarted": "sample string 5",
  "InstallationStartDateEnded": "sample string 6",
  "FirstDayOfInitialTermStarted": "sample string 7",
  "FirstDayOfInitialTermEnded": "sample string 8",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample: 
{"CustomerName":"sample string 1","LessorCountryCode":"sample string 2","Lease":"sample string 3","ScheduleName":"sample string 4","InstallationStartDateStarted":"sample string 5","InstallationStartDateEnded":"sample string 6","FirstDayOfInitialTermStarted":"sample string 7","FirstDayOfInitialTermEnded":"sample string 8","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample: 
<LeaseInProcessFilterModel 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>
  <CustomerName>sample string 1</CustomerName>
  <FirstDayOfInitialTermEnded>sample string 8</FirstDayOfInitialTermEnded>
  <FirstDayOfInitialTermStarted>sample string 7</FirstDayOfInitialTermStarted>
  <InstallationStartDateEnded>sample string 6</InstallationStartDateEnded>
  <InstallationStartDateStarted>sample string 5</InstallationStartDateStarted>
  <Lease>sample string 3</Lease>
  <LessorCountryCode>sample string 2</LessorCountryCode>
  <ScheduleName>sample string 4</ScheduleName>
</LeaseInProcessFilterModel>

application/x-www-form-urlencoded

Sample: 
?CustomerName=SampleString1&LessorCountryCode=SampleString2&Lease=SampleString3&ScheduleName=SampleString4&InstallationStartDateStarted=SampleString5&InstallationStartDateEnded=SampleString6&FirstDayOfInitialTermStarted=SampleString7&FirstDayOfInitialTermEnded=SampleString8&PageNumber=1&PageSize=1

Response Information

Resource Description

The LeaseInProcessModel object, containing the collection of Leases In Process.

LeaseInProcessModel
NameDescriptionTypeAdditional information
ErrorMessage

Optional error message provided by the method call.

 string

None.
LeasesInProcess

Collection of Leases In Process being returned.

 Collection of LeaseInProcess

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: 
{
  "LeasesInProcess": [
    {
      "ID": 1,
      "LeaseNo": "sample string 2",
      "Sched": "sample string 3",
      "LessorCountry": "sample string 4",
      "InstallationStartDate": "2025-05-03T10:53:13.698314-05:00",
      "InstallationEndDate": "2025-05-03T10:53:13.698314-05:00",
      "TermInMonths": 1,
      "BillingFrequency": "sample string 5",
      "InProcessRent": 1.0,
      "Currency": "sample string 6",
      "PaymentFrequency": "sample string 7",
      "PaymentCode": "sample string 8",
      "FirstDayOfInitialTerm": "2025-05-03T10:53:13.698314-05:00"
    },
    {
      "ID": 1,
      "LeaseNo": "sample string 2",
      "Sched": "sample string 3",
      "LessorCountry": "sample string 4",
      "InstallationStartDate": "2025-05-03T10:53:13.698314-05:00",
      "InstallationEndDate": "2025-05-03T10:53:13.698314-05:00",
      "TermInMonths": 1,
      "BillingFrequency": "sample string 5",
      "InProcessRent": 1.0,
      "Currency": "sample string 6",
      "PaymentFrequency": "sample string 7",
      "PaymentCode": "sample string 8",
      "FirstDayOfInitialTerm": "2025-05-03T10:53:13.698314-05:00"
    }
  ],
  "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: 
{"LeasesInProcess":[{"ID":1,"LeaseNo":"sample string 2","Sched":"sample string 3","LessorCountry":"sample string 4","InstallationStartDate":"2025-05-03T10:53:13.698314-05:00","InstallationEndDate":"2025-05-03T10:53:13.698314-05:00","TermInMonths":1,"BillingFrequency":"sample string 5","InProcessRent":1.0,"Currency":"sample string 6","PaymentFrequency":"sample string 7","PaymentCode":"sample string 8","FirstDayOfInitialTerm":"2025-05-03T10:53:13.698314-05:00"},{"ID":1,"LeaseNo":"sample string 2","Sched":"sample string 3","LessorCountry":"sample string 4","InstallationStartDate":"2025-05-03T10:53:13.698314-05:00","InstallationEndDate":"2025-05-03T10:53:13.698314-05:00","TermInMonths":1,"BillingFrequency":"sample string 5","InProcessRent":1.0,"Currency":"sample string 6","PaymentFrequency":"sample string 7","PaymentCode":"sample string 8","FirstDayOfInitialTerm":"2025-05-03T10:53:13.698314-05:00"}],"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: 
<LeaseInProcessModel 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>
  <LeasesInProcess>
    <LeaseInProcess>
      <BillingFrequency>sample string 5</BillingFrequency>
      <Currency>sample string 6</Currency>
      <FirstDayOfInitialTerm>2025-05-03T10:53:13.698314-05:00</FirstDayOfInitialTerm>
      <ID>1</ID>
      <InProcessRent>1</InProcessRent>
      <InstallationEndDate>2025-05-03T10:53:13.698314-05:00</InstallationEndDate>
      <InstallationStartDate>2025-05-03T10:53:13.698314-05:00</InstallationStartDate>
      <LeaseNo>sample string 2</LeaseNo>
      <LessorCountry>sample string 4</LessorCountry>
      <PaymentCode>sample string 8</PaymentCode>
      <PaymentFrequency>sample string 7</PaymentFrequency>
      <Sched>sample string 3</Sched>
      <TermInMonths>1</TermInMonths>
    </LeaseInProcess>
    <LeaseInProcess>
      <BillingFrequency>sample string 5</BillingFrequency>
      <Currency>sample string 6</Currency>
      <FirstDayOfInitialTerm>2025-05-03T10:53:13.698314-05:00</FirstDayOfInitialTerm>
      <ID>1</ID>
      <InProcessRent>1</InProcessRent>
      <InstallationEndDate>2025-05-03T10:53:13.698314-05:00</InstallationEndDate>
      <InstallationStartDate>2025-05-03T10:53:13.698314-05:00</InstallationStartDate>
      <LeaseNo>sample string 2</LeaseNo>
      <LessorCountry>sample string 4</LessorCountry>
      <PaymentCode>sample string 8</PaymentCode>
      <PaymentFrequency>sample string 7</PaymentFrequency>
      <Sched>sample string 3</Sched>
      <TermInMonths>1</TermInMonths>
    </LeaseInProcess>
  </LeasesInProcess>
</LeaseInProcessModel>