MyCSI API - Documentation

GET Return/Items/{id}

Method used to fetch a collection of Returns Items.

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

ReturnItemFilterModel

Name	Description	Type	Additional information
Date_From	Optional, filter Return Items based on the Date_From. For example, if '2017-01-01' was used all of the Return Items with a Date From of January 2017 would be returned.	date	None.
Date_To	Optional, filter Return Items based on the Date_From. For example, if '2017-01-01' was used all of the Return Items with a Date To of January 2017 would be returned.	date	None.
LastUpdated	Optional, filter Return Items based on the last time they were updated. For example, if '2017-01-01' was used, all of the Return Items modified on and since the first of January 2017 would be returned.	date	None.
Lease	Optional, filter Return Items based on the Lease For example, if '1e' is used all of the Return Items with Lease containing '1e' will be returned.	string	None.
Manufacturer	Optional, filter Return Items based on the Manufacturer. For example, if '1e' is used all of the Return Items with Manufacturer containing '1e' will be returned.	string	None.
Model	Optional, filter Return Items based on the Model. For example, if '1e' is used all of the Return Items with Model containing '1e' will be returned.	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.
ProductType	Optional, filter Return Items based on the ProductType. For example, if '1e' is used all of the Return Items with ProductType equal to '1e' will be returned.	string	None.
ProjectNumber	Optional, filter Return Items based on the Project Number. For example, if '1e' is used all of the Return Items with a Project Number containing '1e' will be returned.	string	None.
Returned	Optional, filter Return Items based on Returned. For example, All, Yes, or No values equal to this value will be returned.	string	None.
SerialNumber	Optional, filter Return Items based on the Serial Number. For example, if '1e' is used all of the Return Items with Serial Number containing '1e' will be returned.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProjectNumber": "sample string 1",
  "SerialNumber": "sample string 2",
  "Manufacturer": "sample string 3",
  "Model": "sample string 4",
  "Date_From": "2025-05-03T11:08:22.2547024-05:00",
  "Date_To": "2025-05-03T11:08:22.2547024-05:00",
  "ProductType": "sample string 5",
  "Returned": "sample string 6",
  "Lease": "sample string 7",
  "LastUpdated": "2025-05-03T11:08:22.2547024-05:00",
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample:

{"ProjectNumber":"sample string 1","SerialNumber":"sample string 2","Manufacturer":"sample string 3","Model":"sample string 4","Date_From":"2025-05-03T11:08:22.2547024-05:00","Date_To":"2025-05-03T11:08:22.2547024-05:00","ProductType":"sample string 5","Returned":"sample string 6","Lease":"sample string 7","LastUpdated":"2025-05-03T11:08:22.2547024-05:00","PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample:

<ReturnItemFilterModel 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>
  <Date_From>2025-05-03T11:08:22.2547024-05:00</Date_From>
  <Date_To>2025-05-03T11:08:22.2547024-05:00</Date_To>
  <LastUpdated>2025-05-03T11:08:22.2547024-05:00</LastUpdated>
  <Lease>sample string 7</Lease>
  <Manufacturer>sample string 3</Manufacturer>
  <Model>sample string 4</Model>
  <ProductType>sample string 5</ProductType>
  <ProjectNumber>sample string 1</ProjectNumber>
  <Returned>sample string 6</Returned>
  <SerialNumber>sample string 2</SerialNumber>
</ReturnItemFilterModel>

application/x-www-form-urlencoded

Sample:

?ProjectNumber=SampleString1&SerialNumber=SampleString2&Manufacturer=SampleString3&Model=SampleString4&Date_From=2025-05-03&Date_To=2025-05-03&ProductType=SampleString5&Returned=SampleString6&Lease=SampleString7&LastUpdated=2025-05-03&PageNumber=1&PageSize=1

Response Information

Resource Description

The ReturnItemModel object, containing the collection of Return Items.

ReturnItemModel

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.
ReturnItems	Collection of Return Items being returned.	Collection of ReturnItem	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:

{
  "ReturnItems": [
    {
      "ID": 1,
      "ProjectNumber": 2,
      "InsertDateTime": "2025-05-03T11:08:22.2547024-05:00",
      "UpdateDateTime": "2025-05-03T11:08:22.2547024-05:00",
      "ProductType": "sample string 4",
      "Lease": "sample string 5",
      "IsLeasedAsset": true,
      "SerialNumber": "sample string 6",
      "Manufacturer": "sample string 7",
      "Model": "sample string 8",
      "DateArrivedAtFacilityAsUTC": "2025-05-03T11:08:22.2547024-05:00",
      "WhenCleansedAsUTC": "2025-05-03T11:08:22.2547024-05:00",
      "IsReturned": true,
      "IsSecureTrackRequired": true,
      "HasSecureTrackReport": true,
      "IsMiscellaneous": true,
      "Weight": 1.0
    },
    {
      "ID": 1,
      "ProjectNumber": 2,
      "InsertDateTime": "2025-05-03T11:08:22.2547024-05:00",
      "UpdateDateTime": "2025-05-03T11:08:22.2547024-05:00",
      "ProductType": "sample string 4",
      "Lease": "sample string 5",
      "IsLeasedAsset": true,
      "SerialNumber": "sample string 6",
      "Manufacturer": "sample string 7",
      "Model": "sample string 8",
      "DateArrivedAtFacilityAsUTC": "2025-05-03T11:08:22.2547024-05:00",
      "WhenCleansedAsUTC": "2025-05-03T11:08:22.2547024-05:00",
      "IsReturned": true,
      "IsSecureTrackRequired": true,
      "HasSecureTrackReport": true,
      "IsMiscellaneous": true,
      "Weight": 1.0
    }
  ],
  "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:

{"ReturnItems":[{"ID":1,"ProjectNumber":2,"InsertDateTime":"2025-05-03T11:08:22.2547024-05:00","UpdateDateTime":"2025-05-03T11:08:22.2547024-05:00","ProductType":"sample string 4","Lease":"sample string 5","IsLeasedAsset":true,"SerialNumber":"sample string 6","Manufacturer":"sample string 7","Model":"sample string 8","DateArrivedAtFacilityAsUTC":"2025-05-03T11:08:22.2547024-05:00","WhenCleansedAsUTC":"2025-05-03T11:08:22.2547024-05:00","IsReturned":true,"IsSecureTrackRequired":true,"HasSecureTrackReport":true,"IsMiscellaneous":true,"Weight":1.0},{"ID":1,"ProjectNumber":2,"InsertDateTime":"2025-05-03T11:08:22.2547024-05:00","UpdateDateTime":"2025-05-03T11:08:22.2547024-05:00","ProductType":"sample string 4","Lease":"sample string 5","IsLeasedAsset":true,"SerialNumber":"sample string 6","Manufacturer":"sample string 7","Model":"sample string 8","DateArrivedAtFacilityAsUTC":"2025-05-03T11:08:22.2547024-05:00","WhenCleansedAsUTC":"2025-05-03T11:08:22.2547024-05:00","IsReturned":true,"IsSecureTrackRequired":true,"HasSecureTrackReport":true,"IsMiscellaneous":true,"Weight":1.0}],"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:

<ReturnItemModel 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>
  <ReturnItems>
    <ReturnItem>
      <DateArrivedAtFacilityAsUTC>2025-05-03T11:08:22.2547024-05:00</DateArrivedAtFacilityAsUTC>
      <HasSecureTrackReport>true</HasSecureTrackReport>
      <ID>1</ID>
      <InsertDateTime>2025-05-03T11:08:22.2547024-05:00</InsertDateTime>
      <IsLeasedAsset>true</IsLeasedAsset>
      <IsMiscellaneous>true</IsMiscellaneous>
      <IsReturned>true</IsReturned>
      <IsSecureTrackRequired>true</IsSecureTrackRequired>
      <Lease>sample string 5</Lease>
      <Manufacturer>sample string 7</Manufacturer>
      <Model>sample string 8</Model>
      <ProductType>sample string 4</ProductType>
      <ProjectNumber>2</ProjectNumber>
      <SerialNumber>sample string 6</SerialNumber>
      <UpdateDateTime>2025-05-03T11:08:22.2547024-05:00</UpdateDateTime>
      <Weight>1</Weight>
      <WhenCleansedAsUTC>2025-05-03T11:08:22.2547024-05:00</WhenCleansedAsUTC>
    </ReturnItem>
    <ReturnItem>
      <DateArrivedAtFacilityAsUTC>2025-05-03T11:08:22.2547024-05:00</DateArrivedAtFacilityAsUTC>
      <HasSecureTrackReport>true</HasSecureTrackReport>
      <ID>1</ID>
      <InsertDateTime>2025-05-03T11:08:22.2547024-05:00</InsertDateTime>
      <IsLeasedAsset>true</IsLeasedAsset>
      <IsMiscellaneous>true</IsMiscellaneous>
      <IsReturned>true</IsReturned>
      <IsSecureTrackRequired>true</IsSecureTrackRequired>
      <Lease>sample string 5</Lease>
      <Manufacturer>sample string 7</Manufacturer>
      <Model>sample string 8</Model>
      <ProductType>sample string 4</ProductType>
      <ProjectNumber>2</ProjectNumber>
      <SerialNumber>sample string 6</SerialNumber>
      <UpdateDateTime>2025-05-03T11:08:22.2547024-05:00</UpdateDateTime>
      <Weight>1</Weight>
      <WhenCleansedAsUTC>2025-05-03T11:08:22.2547024-05:00</WhenCleansedAsUTC>
    </ReturnItem>
  </ReturnItems>
</ReturnItemModel>