api.sros¶

/api/sros/search/
- GET /api/sros/search/
- POST /api/sros/search/

/api/sros/search/¶

Data¶

Columns

name	type	required	default	sort_default	can_summarize
lsserver.search.column.id	STRING	False	True	True	False
lsserver.search.column.date	DATE	False	True	False	False
lsserver.search.column.customer	STRING	False	True	False	False
lsserver.search.column.phone	STRING	False	True	False	False
lsserver.search.column.po	STRING	False	True	False	False
lsserver.search.column.user	STRING	False	True	False	False
lsserver.search.column.status	STRING	False	True	False	False
lsserver.search.column.total	MONEY	False	True	False	True
lsserver.search.column.created	DATETIME	False	False	False	False
lsserver.search.column.modified	DATETIME	False	False	False	False
lsserver.search.column.warranty	STRING	False	False	False	False
lsserver.search.column.drop_shipment	BOOLEAN	False	False	False	False
lsserver.search.column.shipping_method	STRING	False	False	False	False
lsserver.search.column.terms	STRING	False	False	False	False
lsserver.search.column.currency	STRING	False	False	False	False
lsserver.search.column.base_custom_field_0	STRING/DATE/BOOLEAN	False	False	False	False

Filters

name	type	required	enum_values
lsserver.search.filters.sro_id	STRING	False	None
lsserver.search.filters.customer_id	STRING	False	None
lsserver.search.filters.customer_name	STRING	False	None
lsserver.search.filters.customer_phone	STRING	False	None
lsserver.search.filters.customer_po	STRING	False	None
lsserver.search.filters.model_checked_in	STRING	False	None
lsserver.search.filters.serial_number_checked_in	STRING	False	None
lsserver.search.filters.warranty	STRING	False	None
lsserver.search.filters.warranty_info	STRING	False	None
lsserver.search.filters.problem_description	STRING	False	None
lsserver.search.filters.work_performed	STRING	False	None
lsserver.search.filters.product_id	STRING	False	None
lsserver.search.filters.upc	STRING	False	None
lsserver.search.filters.part_code	STRING	False	None
lsserver.search.filters.part_description	STRING	False	None
lsserver.search.filters.part_class	STRING	False	None
lsserver.search.filters.part_family	STRING	False	None
lsserver.search.filters.printed_notes	STRING	False	None
lsserver.search.filters.internal_notes	STRING	False	None
lsserver.search.filters.user	STRING	False	None
lsserver.search.filters.status	STRING	False	None
lsserver.search.filters.drop_shipment	BOOLEAN	False	None
lsserver.search.filters.created_date	DATE	False	None
lsserver.search.filters.modified_date	DATE	False	None
lsserver.search.filters.base_custom_field_0	STRING/DATE/BOOLEAN	False	None

GET /api/sros/search/¶

can_lock	requires_lock	has_etag	requires_etag
False	False	False	False

Request:

<!-- No XML Request. -->

Response:

<search_criteria>
    <columns>
        <column id="[str]">
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name> <!-- The localizable name of this column -->
            <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
            <required>[bool]</required><!-- Indicates that this item must be part of the query -->
            <default>[bool]</default><!-- Indicates which columns should be selected by default -->
            <sort_default>[bool]</sort_default><!-- Indicates that this column should be selected as the sort column by default -->
            <sort_default_order_by>[enum: ASC | DESC]</sort_default_order_by><!-- Indicates what the default order by should be for this column -->
            <can_summarize>[bool]</can_summarize><!-- Indicates that this column can be used to generate a summarized total -->

        </column>
        [...]
    </columns>
    <filters>
        <filter id="[str]">
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name> <!-- The localizable name of this filter -->
            <type>[enum: ENUM | STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN ]</type><!-- Defines the type of data this filter represents -->
            <enum_values><!-- Present if and only if type is ENUM -->
                <enum_value>
                    <name>
                        <localizable_message/> <!-- Mutually exclusive with <raw> -->
                        <raw>[str]</raw> <!-- Mutually exclusive with <localizable_message> -->
                    </name> <!-- The name to be displayed -->
                    <value>[str]</value> <!-- The value to be passed to the server in <filters> of a POST -->
                </enum_value>
                [...]
           </enum_values>

        </filter>
        [...]
    </filters>
</search_criteria>

POST /api/sros/search/¶

Description:

Executes a search based on the content of the post. Responses are streamed to
the client.

Note: Read only clients may POST searches.

can_lock	requires_lock	has_etag	requires_etag
False	False	False	False

Request:

<search>
    <include_total>[bool]</include_total> <!-- True by default -->
    <page> <!-- optional if getting the whole dataset -->
        <offset>[int]</offset> <!-- optional -->
        <count>[int]</count> <!-- optional -->
    </page>
    <summarized_column><!-- Optional. When specified, a summarized total is added to the data -->
        <column id="[str]"/>
    </summarized_column>
    <search_query>
        <columns><!-- optional. If no columns are specified, the default columns are selected.-->
            <column id="[str]"/>
            [...]
        </columns>
        <sort_by_column><!-- optional. If not specified, the default columns is used for sorting.  -->
            <column id="[str]"/>
            <order_by>[enum: ASC | DESC]</order_by><!-- Optional. If not specified the default order by is used.-->
        </sort_by_column>
        <filters><!-- optional or content optional-->
            <!--
                Predicate search based on the filter list from the GET

                Predicate searches take the form of:

                lsserver.search.column.fictional_column > 10 AND (lsserver.search.column.fictional_column2 == 0 OR lsserver.search.column.fictional_column3 != 0)
            -->
        </filters>
    </search_query>
</search>

Response:

<data>
    <info>
        <total_count>[int]</total_count>
        <summarized_column>
            <column>
                <name>
                    <localizable_message/> <!-- mutually exclusive with <raw> -->
                    <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
                </name>
                <type>[enum: INTEGER | DECIMAL | MONEY ]</type>
            </column>
        </summarized_column>
        <summarized_total>[int|decimal]</summarized_total>
    </info>
    <columns>
        <column>
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name>
            <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
        </column>
        [...]
    </columns>
    <rows>
        <row>
            <links> <!-- Links to relevant documents -->
                <link>
                    <product uri="" id="" />
                </link>
                [...]
            </links>
            <cell>
                <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
                <value>[str | int | decimal | date | datetime | bool]</value>
            </cell>
            [...] <!-- The count will always match the column count -->
        </row>
    </rows>
</data>

Expected Errors: