XML_PlanSearchDescription

XML message about search conditions of release schedule

<PlanSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
    <searchID><!--required, xs:string, search ID, which is used to check whether the current search requester is the same; the search ID is valid for 5 minutes--></searchID>
    <scheduleNo><!--optional, xs:integer, program schedule No.--></scheduleNo>
    <releaseType><!--optional, xs:string,"byTerminal,byOrg,all"--></releaseType>
    <releaseState><!--optional, xs:string, release status: "notRelease"-not released, releasing, released, all--></releaseState>
    <TimeSpanList><!--optional, release period, if this field is not configured, the release period is not limited-->
        <TimeSpan><!--list-->
            <startTime><!--required, xs:time, start time in ISO 8601 format--></startTime>
            <endTime><!--required, xs:time, end time in ISO 8601 format--></endTime>
        </TimeSpan>
    </TimeSpanList>
    <keyword><!--optional, xs:string, fuzzy search by key word--></keyword>
    <sortBy><!--optional, xs:string, sort mode: "releaseState"-by release status, "releaseTime"-by release time, "taskReleaseState"-by release status, "releaseInfoType"-by release information type--></sortBy>
    <orderMode><!--optional, xs:string, sort mode: ascend, descend--></orderMode>
    <maxResults><!--optional, xs:integer, maximum number of returned results per search--></maxResults>
    <searchResultsPosition><!--optional, xs:integer, , the end position of search result in result list. In a single search, if you cannot get all the records in the result list, you can mark the end position and get the following records after the marked position in the next search--></searchResultsPosition>
    <taskReleaseState><!--optional, xs:string, "notRelease,releasing,failed,success,all"--></taskReleaseState>
    <releaseInfoType><!--optional, xs:string, type of information to be released--></releaseInfoType>
    <terminalListHide><!--optional, xs:boolean, whether to hide the terminal or organization: "true"-yes, "false"-no--></terminalListHide>
</PlanSearchDescription>