MyCSI API - Documentation

GET Query/Schedules/{id}

Method used to query 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

SearchQueryModel containing query definitions. See Schedule Info endpoint for available columns and operators.

SearchQueryModel

Name	Description	Type	Additional information
Columns	A list of columns to be returned in the query result.	Collection of string	None.
Comparison	The comparison operator for the query.	string	None.
Filters	A list of query filters.	Collection of SearchQueryFilterModel	None.
Paging	The paging definition for the query.	SearchQueryPagingModel	None.
Sort	The sorting definition for the query.	SearchQuerySortModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Comparison": "sample string 1",
  "Filters": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "Sort": {
    "Column": "sample string 1",
    "Direction": "sample string 2"
  },
  "Columns": [
    "sample string 1",
    "sample string 2"
  ],
  "Paging": {
    "PageNumber": 1,
    "PageSize": 2
  }
}

application/octet-stream

Sample:

{"Comparison":"sample string 1","Filters":[{"Column":"sample string 1","Operator":"sample string 2","Value":"sample string 3"},{"Column":"sample string 1","Operator":"sample string 2","Value":"sample string 3"}],"Sort":{"Column":"sample string 1","Direction":"sample string 2"},"Columns":["sample string 1","sample string 2"],"Paging":{"PageNumber":1,"PageSize":2}}

application/xml, text/xml

Sample:

<SearchQueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Query">
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Columns>
  <Comparison>sample string 1</Comparison>
  <Filters>
    <SearchQueryFilterModel>
      <Column>sample string 1</Column>
      <Operator>sample string 2</Operator>
      <Value>sample string 3</Value>
    </SearchQueryFilterModel>
    <SearchQueryFilterModel>
      <Column>sample string 1</Column>
      <Operator>sample string 2</Operator>
      <Value>sample string 3</Value>
    </SearchQueryFilterModel>
  </Filters>
  <Paging>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
  </Paging>
  <Sort>
    <Column>sample string 1</Column>
    <Direction>sample string 2</Direction>
  </Sort>
</SearchQueryModel>

application/x-www-form-urlencoded

Sample:

?Comparison=SampleString1&Filters=unknown&Sort=unknown&Columns=unknown&Paging=unknown

Response Information

Resource Description

SearchQueryResult containing the collection of Schedules.

SearchQueryResult

Name	Description	Type	Additional information
Data	Collection of data being returned.	Collection of Object	None.
ErrorMessage	Optional error message provided by the method call.	string	None.
Message	Optional message provided by the method call.	string	None.
PageNumber	Current page number.	integer	None.
PageSize	Number of items per page.	integer	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.
TotalItems	Total number of objects.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {},
    {}
  ],
  "PageNumber": 1,
  "PageSize": 2,
  "TotalItems": 3,
  "Message": "sample string 4",
  "ErrorMessage": "sample string 5",
  "Success": true,
  "StatusCode": 100
}

application/octet-stream

Sample:

{"Data":[{},{}],"PageNumber":1,"PageSize":2,"TotalItems":3,"Message":"sample string 4","ErrorMessage":"sample string 5","Success":true,"StatusCode":100}

application/xml, text/xml

Sample:

<SearchQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Query">
  <ErrorMessage i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared" />
  <Message i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared" />
  <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>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Data>
  <ErrorMessage>sample string 5</ErrorMessage>
  <Message>sample string 4</Message>
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <TotalItems>3</TotalItems>
</SearchQueryResult>