MyCSI API - Documentation

GET Return/{id}

Method used to fetch a collection of Returns.

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

ReturnFilterModel

Name	Description	Type	Additional information
Address	Optional, the Address of the Return.	string	None.
AssetCount_From		integer	None.
AssetCount_To		integer	None.
Date_From	Optional, the Date_From of the Return. 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.
Date_To	Optional, the Date_To of the Return. 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.
LastUpdated	Optional, filter Returns based on the last time they were updated. For example, if '2017-01-01' was used, all of the Returns modified on and since the first of January 2017 would be returned.	date	None.
Lease	Optional, the Master Lease No to which the Return belongs.	string	None.
LessorCountryCode	Optional, country code of the Lessor to which the Return 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.
Pickup	Optional, the Pick up of Return.	string	None.
ProjectNumber	Optional, the Return Project to which the Return belongs.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProjectNumber": "sample string 1",
  "Pickup": "sample string 2",
  "Address": "sample string 3",
  "Date_From": "2025-05-03T10:45:51.3188023-05:00",
  "Date_To": "2025-05-03T10:45:51.3188023-05:00",
  "AssetCount_From": 1,
  "AssetCount_To": 1,
  "Lease": "sample string 4",
  "LessorCountryCode": "sample string 5",
  "LastUpdated": "2025-05-03T10:45:51.3188023-05:00",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample:

{"ProjectNumber":"sample string 1","Pickup":"sample string 2","Address":"sample string 3","Date_From":"2025-05-03T10:45:51.3188023-05:00","Date_To":"2025-05-03T10:45:51.3188023-05:00","AssetCount_From":1,"AssetCount_To":1,"Lease":"sample string 4","LessorCountryCode":"sample string 5","LastUpdated":"2025-05-03T10:45:51.3188023-05:00","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample:

<ReturnFilterModel 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 3</Address>
  <AssetCount_From>1</AssetCount_From>
  <AssetCount_To>1</AssetCount_To>
  <Date_From>2025-05-03T10:45:51.3188023-05:00</Date_From>
  <Date_To>2025-05-03T10:45:51.3188023-05:00</Date_To>
  <LastUpdated>2025-05-03T10:45:51.3188023-05:00</LastUpdated>
  <Lease>sample string 4</Lease>
  <LessorCountryCode>sample string 5</LessorCountryCode>
  <Pickup>sample string 2</Pickup>
  <ProjectNumber>sample string 1</ProjectNumber>
</ReturnFilterModel>

application/x-www-form-urlencoded

Sample:

?ProjectNumber=SampleString1&Pickup=SampleString2&Address=SampleString3&Date_From=2025-05-03&Date_To=2025-05-03&AssetCount_From=1&AssetCount_To=1&Lease=SampleString4&LessorCountryCode=SampleString5&LastUpdated=2025-05-03&PageNumber=1&PageSize=1

Response Information

Resource Description

The ReturnModel object, containing the collection of Returns.

ReturnModel

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.
Returns	Collection Returns being returned.	Collection of Return	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:

{
  "Returns": [
    {
      "ID": 1,
      "InsertDateTime": "2025-05-03T10:45:51.3188023-05:00",
      "UpdateDateTime": "2025-05-03T10:45:51.3188023-05:00",
      "ProjectNumber": 3,
      "Lease": "sample string 4",
      "LessorCountryCode": "sample string 5",
      "DateArrivedAtFacilityAsUTC": "2025-05-03T10:45:51.3188023-05:00",
      "WhenModifiedAsUTC": "2025-05-03T10:45:51.3188023-05:00",
      "Carrier": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "AddressLine3": "sample string 9",
      "AddressLine4": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "PostalCode": "sample string 13",
      "Country": "sample string 14",
      "NumberOfItems": 1,
      "PickupLocation": "sample string 15",
      "HasSecureTrackReport": true,
      "ReceivedWarehouse": "sample string 16",
      "IsThirdParty": true,
      "HasMiscellaneousItems": true,
      "NumberOfMiscellaneousItems": 1,
      "WeightOfMiscellaneousItems": 1.0,
      "DateCanceled": "2025-05-03T10:45:51.3188023-05:00"
    },
    {
      "ID": 1,
      "InsertDateTime": "2025-05-03T10:45:51.3188023-05:00",
      "UpdateDateTime": "2025-05-03T10:45:51.3188023-05:00",
      "ProjectNumber": 3,
      "Lease": "sample string 4",
      "LessorCountryCode": "sample string 5",
      "DateArrivedAtFacilityAsUTC": "2025-05-03T10:45:51.3188023-05:00",
      "WhenModifiedAsUTC": "2025-05-03T10:45:51.3188023-05:00",
      "Carrier": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "AddressLine3": "sample string 9",
      "AddressLine4": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "PostalCode": "sample string 13",
      "Country": "sample string 14",
      "NumberOfItems": 1,
      "PickupLocation": "sample string 15",
      "HasSecureTrackReport": true,
      "ReceivedWarehouse": "sample string 16",
      "IsThirdParty": true,
      "HasMiscellaneousItems": true,
      "NumberOfMiscellaneousItems": 1,
      "WeightOfMiscellaneousItems": 1.0,
      "DateCanceled": "2025-05-03T10:45:51.3188023-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:

{"Returns":[{"ID":1,"InsertDateTime":"2025-05-03T10:45:51.3188023-05:00","UpdateDateTime":"2025-05-03T10:45:51.3188023-05:00","ProjectNumber":3,"Lease":"sample string 4","LessorCountryCode":"sample string 5","DateArrivedAtFacilityAsUTC":"2025-05-03T10:45:51.3188023-05:00","WhenModifiedAsUTC":"2025-05-03T10:45:51.3188023-05:00","Carrier":"sample string 6","AddressLine1":"sample string 7","AddressLine2":"sample string 8","AddressLine3":"sample string 9","AddressLine4":"sample string 10","City":"sample string 11","State":"sample string 12","PostalCode":"sample string 13","Country":"sample string 14","NumberOfItems":1,"PickupLocation":"sample string 15","HasSecureTrackReport":true,"ReceivedWarehouse":"sample string 16","IsThirdParty":true,"HasMiscellaneousItems":true,"NumberOfMiscellaneousItems":1,"WeightOfMiscellaneousItems":1.0,"DateCanceled":"2025-05-03T10:45:51.3188023-05:00"},{"ID":1,"InsertDateTime":"2025-05-03T10:45:51.3188023-05:00","UpdateDateTime":"2025-05-03T10:45:51.3188023-05:00","ProjectNumber":3,"Lease":"sample string 4","LessorCountryCode":"sample string 5","DateArrivedAtFacilityAsUTC":"2025-05-03T10:45:51.3188023-05:00","WhenModifiedAsUTC":"2025-05-03T10:45:51.3188023-05:00","Carrier":"sample string 6","AddressLine1":"sample string 7","AddressLine2":"sample string 8","AddressLine3":"sample string 9","AddressLine4":"sample string 10","City":"sample string 11","State":"sample string 12","PostalCode":"sample string 13","Country":"sample string 14","NumberOfItems":1,"PickupLocation":"sample string 15","HasSecureTrackReport":true,"ReceivedWarehouse":"sample string 16","IsThirdParty":true,"HasMiscellaneousItems":true,"NumberOfMiscellaneousItems":1,"WeightOfMiscellaneousItems":1.0,"DateCanceled":"2025-05-03T10:45:51.3188023-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:

<ReturnModel 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>
  <Returns>
    <Return>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <AddressLine3>sample string 9</AddressLine3>
      <AddressLine4>sample string 10</AddressLine4>
      <Carrier>sample string 6</Carrier>
      <City>sample string 11</City>
      <Country>sample string 14</Country>
      <DateArrivedAtFacilityAsUTC>2025-05-03T10:45:51.3188023-05:00</DateArrivedAtFacilityAsUTC>
      <DateCanceled>2025-05-03T10:45:51.3188023-05:00</DateCanceled>
      <HasMiscellaneousItems>true</HasMiscellaneousItems>
      <HasSecureTrackReport>true</HasSecureTrackReport>
      <ID>1</ID>
      <InsertDateTime>2025-05-03T10:45:51.3188023-05:00</InsertDateTime>
      <IsThirdParty>true</IsThirdParty>
      <Lease>sample string 4</Lease>
      <LessorCountryCode>sample string 5</LessorCountryCode>
      <NumberOfItems>1</NumberOfItems>
      <NumberOfMiscellaneousItems>1</NumberOfMiscellaneousItems>
      <PickupLocation>sample string 15</PickupLocation>
      <PostalCode>sample string 13</PostalCode>
      <ProjectNumber>3</ProjectNumber>
      <ReceivedWarehouse>sample string 16</ReceivedWarehouse>
      <State>sample string 12</State>
      <UpdateDateTime>2025-05-03T10:45:51.3188023-05:00</UpdateDateTime>
      <WeightOfMiscellaneousItems>1</WeightOfMiscellaneousItems>
      <WhenModifiedAsUTC>2025-05-03T10:45:51.3188023-05:00</WhenModifiedAsUTC>
    </Return>
    <Return>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <AddressLine3>sample string 9</AddressLine3>
      <AddressLine4>sample string 10</AddressLine4>
      <Carrier>sample string 6</Carrier>
      <City>sample string 11</City>
      <Country>sample string 14</Country>
      <DateArrivedAtFacilityAsUTC>2025-05-03T10:45:51.3188023-05:00</DateArrivedAtFacilityAsUTC>
      <DateCanceled>2025-05-03T10:45:51.3188023-05:00</DateCanceled>
      <HasMiscellaneousItems>true</HasMiscellaneousItems>
      <HasSecureTrackReport>true</HasSecureTrackReport>
      <ID>1</ID>
      <InsertDateTime>2025-05-03T10:45:51.3188023-05:00</InsertDateTime>
      <IsThirdParty>true</IsThirdParty>
      <Lease>sample string 4</Lease>
      <LessorCountryCode>sample string 5</LessorCountryCode>
      <NumberOfItems>1</NumberOfItems>
      <NumberOfMiscellaneousItems>1</NumberOfMiscellaneousItems>
      <PickupLocation>sample string 15</PickupLocation>
      <PostalCode>sample string 13</PostalCode>
      <ProjectNumber>3</ProjectNumber>
      <ReceivedWarehouse>sample string 16</ReceivedWarehouse>
      <State>sample string 12</State>
      <UpdateDateTime>2025-05-03T10:45:51.3188023-05:00</UpdateDateTime>
      <WeightOfMiscellaneousItems>1</WeightOfMiscellaneousItems>
      <WhenModifiedAsUTC>2025-05-03T10:45:51.3188023-05:00</WhenModifiedAsUTC>
    </Return>
  </Returns>
</ReturnModel>