MyCSI API - Documentation

GET Schedules/{id}

Method used to fetch a collection of Schedules.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Security token provided via the Authentication method.	globally unique identifier	Required

Body Parameters

Objects used to page through the collection of Schedules, as well as filter the returned objects.

ScheduleFilterModel

Name	Description	Type	Additional information
LastUpdated	Optional, filter Schedules by the last date when they were updated. For example, if '2017-01-01' was used, all of the Schedules updated on and since the first of January 2017 would be returned.	date	None.
Lease	Optional, the Lease 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.

Request Formats

application/json, text/json

Sample:

{
  "LessorCountryCode": "sample string 1",
  "Lease": "sample string 2",
  "LastUpdated": "2025-05-03T11:21:04.0906622-05:00",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample:

{"LessorCountryCode":"sample string 1","Lease":"sample string 2","LastUpdated":"2025-05-03T11:21:04.0906622-05:00","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample:

<ScheduleFilterModel 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>
  <LastUpdated>2025-05-03T11:21:04.0906622-05:00</LastUpdated>
  <Lease>sample string 2</Lease>
  <LessorCountryCode>sample string 1</LessorCountryCode>
</ScheduleFilterModel>

application/x-www-form-urlencoded

Sample:

?LessorCountryCode=SampleString1&Lease=SampleString2&LastUpdated=2025-05-03&PageNumber=1&PageSize=1

Response Information

Resource Description

The ScheduleModel object, containing the collection of Schedules.

ScheduleModel

Name	Description	Type	Additional information
ErrorMessage	Optional error message provided by the method call.	string	None.
Message	Optional message provided by the method call.	string	None.
Paging	Contains information relevant to paging through a collection of objects.	PagingModel	None.
Schedules	Collection of Assets being returned.	Collection of Schedule	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:

{
  "Message": "sample string 1",
  "StatusCode": 100,
  "Success": true,
  "Schedules": [
    {
      "ScheduleID": 1,
      "Lease": "sample string 2",
      "ScheduleName": "sample string 3",
      "TermStartDate": "2025-05-03T11:21:04.0906622-05:00",
      "TermEndDate": "2025-05-03T11:21:04.0906622-05:00",
      "LessorCountryCode": "sample string 4",
      "LessorCountry": "sample string 5",
      "Tax": 1.0,
      "Rent": 1.0,
      "Currency": "sample string 6",
      "LastUpdated": "2025-05-03T11:21:04.0906622-05:00",
      "TermLength": 1,
      "TermCode": "sample string 7",
      "Term": "sample string 8",
      "PaymentFrequency": "sample string 9",
      "PaymentCode": "sample string 10"
    },
    {
      "ScheduleID": 1,
      "Lease": "sample string 2",
      "ScheduleName": "sample string 3",
      "TermStartDate": "2025-05-03T11:21:04.0906622-05:00",
      "TermEndDate": "2025-05-03T11:21:04.0906622-05:00",
      "LessorCountryCode": "sample string 4",
      "LessorCountry": "sample string 5",
      "Tax": 1.0,
      "Rent": 1.0,
      "Currency": "sample string 6",
      "LastUpdated": "2025-05-03T11:21:04.0906622-05:00",
      "TermLength": 1,
      "TermCode": "sample string 7",
      "Term": "sample string 8",
      "PaymentFrequency": "sample string 9",
      "PaymentCode": "sample string 10"
    }
  ],
  "Paging": {
    "PageSize": 1,
    "PageNumber": 2,
    "TotalPages": 3,
    "TotalItems": 4
  },
  "ErrorMessage": "sample string 3"
}

application/octet-stream

Sample:

{"Message":"sample string 1","StatusCode":100,"Success":true,"Schedules":[{"ScheduleID":1,"Lease":"sample string 2","ScheduleName":"sample string 3","TermStartDate":"2025-05-03T11:21:04.0906622-05:00","TermEndDate":"2025-05-03T11:21:04.0906622-05:00","LessorCountryCode":"sample string 4","LessorCountry":"sample string 5","Tax":1.0,"Rent":1.0,"Currency":"sample string 6","LastUpdated":"2025-05-03T11:21:04.0906622-05:00","TermLength":1,"TermCode":"sample string 7","Term":"sample string 8","PaymentFrequency":"sample string 9","PaymentCode":"sample string 10"},{"ScheduleID":1,"Lease":"sample string 2","ScheduleName":"sample string 3","TermStartDate":"2025-05-03T11:21:04.0906622-05:00","TermEndDate":"2025-05-03T11:21:04.0906622-05:00","LessorCountryCode":"sample string 4","LessorCountry":"sample string 5","Tax":1.0,"Rent":1.0,"Currency":"sample string 6","LastUpdated":"2025-05-03T11:21:04.0906622-05:00","TermLength":1,"TermCode":"sample string 7","Term":"sample string 8","PaymentFrequency":"sample string 9","PaymentCode":"sample string 10"}],"Paging":{"PageSize":1,"PageNumber":2,"TotalPages":3,"TotalItems":4},"ErrorMessage":"sample string 3"}

application/xml, text/xml

Sample:

<ScheduleModel 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 1</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>
  <Schedules>
    <Schedule>
      <Currency>sample string 6</Currency>
      <LastUpdated>2025-05-03T11:21:04.0906622-05:00</LastUpdated>
      <Lease>sample string 2</Lease>
      <LessorCountry>sample string 5</LessorCountry>
      <LessorCountryCode>sample string 4</LessorCountryCode>
      <PaymentCode>sample string 10</PaymentCode>
      <PaymentFrequency>sample string 9</PaymentFrequency>
      <Rent>1</Rent>
      <ScheduleID>1</ScheduleID>
      <ScheduleName>sample string 3</ScheduleName>
      <Tax>1</Tax>
      <Term>sample string 8</Term>
      <TermCode>sample string 7</TermCode>
      <TermEndDate>2025-05-03T11:21:04.0906622-05:00</TermEndDate>
      <TermLength>1</TermLength>
      <TermStartDate>2025-05-03T11:21:04.0906622-05:00</TermStartDate>
    </Schedule>
    <Schedule>
      <Currency>sample string 6</Currency>
      <LastUpdated>2025-05-03T11:21:04.0906622-05:00</LastUpdated>
      <Lease>sample string 2</Lease>
      <LessorCountry>sample string 5</LessorCountry>
      <LessorCountryCode>sample string 4</LessorCountryCode>
      <PaymentCode>sample string 10</PaymentCode>
      <PaymentFrequency>sample string 9</PaymentFrequency>
      <Rent>1</Rent>
      <ScheduleID>1</ScheduleID>
      <ScheduleName>sample string 3</ScheduleName>
      <Tax>1</Tax>
      <Term>sample string 8</Term>
      <TermCode>sample string 7</TermCode>
      <TermEndDate>2025-05-03T11:21:04.0906622-05:00</TermEndDate>
      <TermLength>1</TermLength>
      <TermStartDate>2025-05-03T11:21:04.0906622-05:00</TermStartDate>
    </Schedule>
  </Schedules>
</ScheduleModel>