XML_PlaySchedule

XML message about parameters of a specific program schedule

<PlaySchedule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
  <id><!--required, xs:integer, program schedule No.--></id>
  <scheduleName><!--required, xs:string, program schedule name--></scheduleName>
  <scheduleRemarks><!--optional, xs:string, program schedule description--></scheduleRemarks>
  <approveState><!--optional, xs:string, approval status: "approved"-pass, "notPass"-not pass, "notApprove"-not approved--></approveState>
  <approveRemarks><!--optional, xs:string, approval remarks--></approveRemarks>
  <scheduleMode><!--optional, xs:string, program schedule mode: mormal, decode and touch--></scheduleMode>
  <orgNo><!--optional, xs:integer, organization No.--></orgNo>
  <scheduleType><!--optional, xs:string, program schedule type: "daily"-daily schedule, "weekly"-weekly schedule, "selfDefine"-custom schedule, "loop"-loop schedule, "defaultSchedule"-default schedule--></scheduleType>
  <shareProperty><!--optional, xs:string, shared property: public, private--></shareProperty>
  <DailySchedule><!--dependent, daily schedule-->
    <PlaySpanList><!--required-->
      <PlaySpan><!--required-->
        <id><!--required, xs:integer, day of a month, "1,2,3..."--></id>
        <programNo><!--required, xs:integer, No. of the shown program--></programNo>
        <TimeRange><!--required, play duration-->   
          <beginTime><!--required, xs:time, start time (ISO 8601 format)--></beginTime> 
          <endTime><!--required, xs:time, end time (ISO 8601 format)--></endTime> 
        </TimeRange>
      </PlaySpan>
    </PlaySpanList>    
  </DailySchedule>
  <WeeklySchedule><!--dependent, weekly schedule-->
    <DayList><!--required-->
      <Day><!--required-->
        <id><!--required, xs:integer, day of a month, "1,2,3..."--></id>
        <dayOfWeek><!--required, xs:string, day of a week --></dayOfWeek>
        <PlaySpanList><!--required, play schedule-->
        <PlaySpan><!--required-->
	  <id><!--required, xs:integer, day of a month, "1,2,3..."--></id>
	  <programNo><!--required, xs:integer, No. of the looped program--></programNo>
	  <TimeRange><!--required, play duration--> 
            <beginTime><!--required, xs:time, start time (ISO 8601 format)--></beginTime> 
            <endTime><!--required, xs:time, end time (ISO 8601 format)--></endTime> 
          </TimeRange>
        </PlaySpan>
      </PlaySpanList>
    </Day>
  </DayList>
  </WeeklySchedule>
  <LoopSchedule><!--dependent, loop schedule-->
    <ProgramNoList><!--required, list of loop programs, normal mode-->
      <programNo><!--required, xs:integer, No. of the looped program--></programNo>
    </ProgramNoList>
    <LoopTimeSpanList><!--dependent-->
      <LoopTimeSpan><!--optional-->
        <TimeRange><!--required, play duration--> 
          <beginTime><!--required, xs:time, start time (ISO 8601 format)--></beginTime> 
          <endTime><!--required, xs:time, end time (ISO 8601 format)--></endTime> 
        </TimeRange>
        <ProgramNoList><!--required, list of looped programs-->
          <programNo><!--required, xs:integer, program No.--></programNo>
	</ProgramNoList>
      </LoopTimeSpan>
    </LoopTimeSpanList>
  </LoopSchedule>
  <SelfDefineSchedule><!--dependent-->
    <SelfDefineList><!--required-->
      <SelfDefine><!--required, custom period-->
        <id><!--required, xs:integer, custom period No.--></id>
        <programNo><!--required, xs:integer, program No., which is returned by calling the API /ISAPI/Publish/ProgramMgr/program--></programNo>
        <TimeRange><!--required, play duration--> 
          <beginTime><!--required, xs:time, start time (ISO 8601 format)--></beginTime> 
          <endTime><!--required, xs:time, end time (ISO 8601 format)--></endTime> 
        </TimeRange>
      </SelfDefine>
    </SelfDefineList>
  </SelfDefineSchedule>
  <DefaultSchedule><!--dependent, default program schedule-->
    <programNo><!--required, xs:integer, program No.--></programNo>
  </DefaultSchedule>
  <HolidaySchedule><!--optional, holiday schedule-->
    <PlaySpanList><!--required, daily schedule-->
      <PlaySpan><!--required, daily schedule-->
        <id><!--required, xs:integer, day of a month, "1,2,3..."--></id>
        <programNo><!--required, xs:integer, program No.--></programNo>
        <TimeRange><!--required, play duration--> 
          <beginTime><!--required, xs:time, start time (ISO 8601 format)--></beginTime> 
          <endTime><!--required, xs:time, end time (ISO 8601 format)--></endTime> 
        </TimeRange>
      </PlaySpan>
    </PlaySpanList>
  </HolidaySchedule>
</PlaySchedule>