Find Advertisement Status operation

This Find Advertisement Status operation finds the status of an advertisement.

The following table describes the <items> XML elements for the Find Advertisement Status operation:

Elements for the <items> XML element and adapter request for the Find Advertisement Status operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-advertisement-status`	Yes
`<arguments>`	Specifies a list of arguments required for this operation	Yes
`<target>`	Specifies the connection information for the Microsoft System Center Configuration Manager application Valid values: The value specified for the `<target>` element must be the same as that specified for the name attribute of the `<config>` element in the adapter configuration. Default value: The first configuration defined in the adapter configuration	No
`<advertisement-id>`	Specifies a string identifier for the advertisement whose status is to be searched	No
`<advertisement-name>`	Specifies the name of the advertisement	No
`<advertisements-failed>`	Specifies the total number of users, user groups, or client computers that experienced an error in processing the advertisement or its associated program, or that attempted to run the advertised program but failed before the program could be started Valid values: Any positive integer	No
`<advertisements-received>`	Specifies the total number of users, user groups, or client computers that report successful receipt of the advertisement Valid values: Any positive integer	No
`<collection-id>`	Specifies a string identifier for the collection at which the advertisement is targeted	No
`<collection-name>`	Specifies the name of the collection at which the advertisement is targeted	No
`<display-schedule>`	Specifies the interval string that specifies the schedule for which the statistics apply Valid values: 0181128000100008 - Since 12:00:00 AM 00C1128000100008 - Since 6:00:00 AM 0181128000100008 - Since 12:00:00 PM 0241128000100008 - Since 6:00:00 PM 0001128000192000 - Since Sunday 00011280001A2000 - Since Monday 00011280001B2000 - Since Tuesday 00011280001C2000 - Since Wednesday 00011280001D2000 - Since Thursday 00011280001E2000 - Since Friday 00011280001F2000 - Since Saturday 000A470000284400 - Since 1st of the month 000A4700002BC400 - Since 15th of the month 0001128000080008 - Since Advertised The above values represent a particular schedule after which the statistics are reset to zero.	No
`<expiration-time>`	Specifies the date and time when the advertisement expires and is no longer available to clients Valid values: Any input in datetime format - YYYYmmDDhhMMssuuuuuu+* YYYY: year; mm: month; DD: date; hh: hour; MM: minute; ss: second; uuuuuu: microsecond; +*: Offset from local time	No
`<package-id>`	Specifies a string identifier for the package with which the advertised program is associated	No
`<package-language>`	Specifies the language of the package Valid values: English, German	No
`<package-manufacturer>`	Specifies the manufacturer of the package No <package-name> Specifies the name of the package	No
`<package-version>`	Specifies the version of the package	No
`<available-after>`	Specifies the date and time when the advertisement is presented to the clients	No
`program-name>`	Specifies the name of the program (related to PackageID) that the advertisement advertises	No
`<programs-failed>`	Specifies the total number of users, user groups, or client computers that reported errors while running the advertised program Valid values: Any positive integer	No
`<programs-failed-mif>`	Specifies the total number of programs that failed relative to the Management Information Format installation status file Valid values: Any positive integer	No
`<programs-started>`	Specifies the total number of users, user groups, or client computers in the site that successfully ran the advertised program Valid values: Any positive integer	No
`<programs-succeeded>`	Specifies the total number of users, user groups, or client computers, or both, which report that the program ran successfully Valid values: Any positive integer	No
`<programs-succeeded-mif>`	Specifies the total number of programs that succeeded relative to the Management Information Format installation status file Valid values: Any positive integer	No
`<site-code`	Specifies the code of the Microsoft System Center Configuration Manager site where the advertisement originates	No
`<time-enable-flag>`	Specifies the time-enable flag and is reserved for future use Valid values: Any positive integer	No

The following figure shows a sample adapter request for the Find Advertisement Status operation:

Sample adapter request for the Find Advertisement Status operation

<mssccm-request>
    <operation-name>find-advertisement-status</operation-name>
    <arguments>
      <target>config1</target>
      <advertisement-id>12320121</advertisement-id>
      <advertisement-name><![CDATA[adv002]]></advertisement-name>
      <advertisements-failed>0</advertisements-failed>
      <advertisements-received>0</advertisements-received>
      <collection-id>SMS00002</collection-id>
      <collection-name>All Users</collection-name>
      <display-schedule>0241128000100008</display-schedule>
      <expiration-time>20120201000000.000000+***</expiration-time>
      <package-id>12300001</package-id>
      <package-language>English</package-language>
      <package-manufacturer>admin</package-manufacturer>
      <package-name>pkgName</package-name>
      <package-version>1.0</package-version>
      <available-after>20110201000000.000000+***</available-after>
      <program-name>p2</program-name>
      <programs-failed>0</programs-failed>
      <programs-failed-mif>0</programs-failed-mif>
      <programs-started>0</programs-started>
      <programs-succeeded>0</programs-succeeded>
      <programs-succeeded-mif>0</programs-succeeded-mif>
      <site-code>123</site-code>
      <time-enable-flag>13075</time-enable-flag>
    </arguments>
  </mssccm-request>

The following figure shows the adapter response for the sample request:

Sample adapter response for the Find Advertisement Status operation

<mssccm-response>
  <metadata>
    <response-count>1</response-count>
    <status>success</status>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>config1</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <advertisement-id>12320121</advertisement-id>
        <advertisement-name><![CDATA[adv002]]></advertisement-name>
        <advertisements-failed>0</advertisements-failed>
        <advertisements-received>0</advertisements-received>
        <collection-id>SMS00002</collection-id>
        <collection-name><![CDATA[All Users]]></collection-name>
        <display-schedule>0241128000100008</display-schedule>
        <expiration-time>20120201000000.000000+***</expiration-time>
        <package-id>12300001</package-id>
        <package-language>English</package-language>
        <package-manufacturer>admin</package-manufacturer>
        <package-name><![CDATA[pkgName]]></package-name>
        <package-version>1.0</package-version>
        <available-after>20110201000000.000000+***</available-after>
        <program-name>p2</program-name>
        <programs-failed>0</programs-failed>
        <programs-failed-mif>0</programs-failed-mif>
        <programs-started>0</programs-started>
        <programs-succeeded>0</programs-succeeded>
        <programs-succeeded-mif>0</programs-succeeded-mif>
        <site-code>123</site-code>
        <time-enable-flag>13075</time-enable-flag>
      </output>
    </response>
  </responses>
</mssccm-response>

Find Advertisement Status operation

Comments