MyCSI API - Documentation

GET Query/Invoices/Info/{id}

Method used to get query information for Invoices.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

SearchQueryInfoModel containing the query information for Invoices.

SearchQueryInfoModel

Name	Description	Type	Additional information
Columns	Available columns and filter operators for this query method.	Collection of SearchQueryColumnModel	None.
ComparisonOperators	Available comparison operators for this query method.	Collection of SearchQueryOperatorModel	None.
ErrorMessage	Optional error message provided by the method call.	string	None.
Message	Optional message provided by the method call.	string	None.
SortOperators	Available sort operators for this query method.	Collection of SearchQueryOperatorModel	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:

{
  "ComparisonOperators": [
    {
      "Operator": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Operator": "sample string 1",
      "Description": "sample string 2"
    }
  ],
  "SortOperators": [
    {
      "Operator": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Operator": "sample string 1",
      "Description": "sample string 2"
    }
  ],
  "Columns": [
    {
      "Column": "sample string 1",
      "DateType": "sample string 2",
      "Operators": [
        {
          "Operator": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Operator": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Column": "sample string 1",
      "DateType": "sample string 2",
      "Operators": [
        {
          "Operator": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Operator": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    }
  ],
  "Message": "sample string 1",
  "ErrorMessage": "sample string 2",
  "Success": true,
  "StatusCode": 100
}

application/xml, text/xml

Sample:

<SearchQueryInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Query.Info">
  <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>
  <Columns>
    <SearchQueryColumnModel>
      <Column>sample string 1</Column>
      <DateType>sample string 2</DateType>
      <Operators>
        <SearchQueryOperatorModel>
          <Description>sample string 2</Description>
          <Operator>sample string 1</Operator>
        </SearchQueryOperatorModel>
        <SearchQueryOperatorModel>
          <Description>sample string 2</Description>
          <Operator>sample string 1</Operator>
        </SearchQueryOperatorModel>
      </Operators>
    </SearchQueryColumnModel>
    <SearchQueryColumnModel>
      <Column>sample string 1</Column>
      <DateType>sample string 2</DateType>
      <Operators>
        <SearchQueryOperatorModel>
          <Description>sample string 2</Description>
          <Operator>sample string 1</Operator>
        </SearchQueryOperatorModel>
        <SearchQueryOperatorModel>
          <Description>sample string 2</Description>
          <Operator>sample string 1</Operator>
        </SearchQueryOperatorModel>
      </Operators>
    </SearchQueryColumnModel>
  </Columns>
  <ComparisonOperators>
    <SearchQueryOperatorModel>
      <Description>sample string 2</Description>
      <Operator>sample string 1</Operator>
    </SearchQueryOperatorModel>
    <SearchQueryOperatorModel>
      <Description>sample string 2</Description>
      <Operator>sample string 1</Operator>
    </SearchQueryOperatorModel>
  </ComparisonOperators>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Message>sample string 1</Message>
  <SortOperators>
    <SearchQueryOperatorModel>
      <Description>sample string 2</Description>
      <Operator>sample string 1</Operator>
    </SearchQueryOperatorModel>
    <SearchQueryOperatorModel>
      <Description>sample string 2</Description>
      <Operator>sample string 1</Operator>
    </SearchQueryOperatorModel>
  </SortOperators>
</SearchQueryInfoModel>