POST api/ssrsreport/subscribe

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
report_id	integer	None.
report_name	string	None.
subscription_id	string	None.
schedule_type	ScheduleType	None.
is_week_day	boolean	None.
week_days_list	string	None.
is_repeat_after_days	boolean	None.
repeat_after_days	integer	None.
repeat_after_weeks	integer	None.
month_list	string	None.
is_week_of_month	boolean	None.
week_of_month	string	None.
is_runs_on_specific_days	boolean	None.
month_day_range	string	None.
schedule_time	string	None.
start_schedule_date	string	None.
is_stop_schedule_date	boolean	None.
stop_schedule_date	string	None.
email_to	string	None.
subject	string	None.
report_output_format	string	None.
report_parameters	Collection of Pair of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "report_id": 1,
  "report_name": "sample string 2",
  "subscription_id": "sample string 3",
  "schedule_type": 1,
  "is_week_day": true,
  "week_days_list": "sample string 5",
  "is_repeat_after_days": true,
  "repeat_after_days": 1,
  "repeat_after_weeks": 1,
  "month_list": "sample string 7",
  "is_week_of_month": true,
  "week_of_month": "sample string 9",
  "is_runs_on_specific_days": true,
  "month_day_range": "sample string 11",
  "schedule_time": "sample string 12",
  "start_schedule_date": "sample string 13",
  "is_stop_schedule_date": true,
  "stop_schedule_date": "sample string 15",
  "email_to": "sample string 16",
  "subject": "sample string 17",
  "report_output_format": "sample string 18",
  "report_parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

text/html

Sample:

{"report_id":1,"report_name":"sample string 2","subscription_id":"sample string 3","schedule_type":1,"is_week_day":true,"week_days_list":"sample string 5","is_repeat_after_days":true,"repeat_after_days":1,"repeat_after_weeks":1,"month_list":"sample string 7","is_week_of_month":true,"week_of_month":"sample string 9","is_runs_on_specific_days":true,"month_day_range":"sample string 11","schedule_time":"sample string 12","start_schedule_date":"sample string 13","is_stop_schedule_date":true,"stop_schedule_date":"sample string 15","email_to":"sample string 16","subject":"sample string 17","report_output_format":"sample string 18","report_parameters":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}]}

application/xml, text/xml

Sample:

<SSRSReportSubscriptionItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
  <email_to>sample string 16</email_to>
  <is_repeat_after_days>true</is_repeat_after_days>
  <is_runs_on_specific_days>true</is_runs_on_specific_days>
  <is_stop_schedule_date>true</is_stop_schedule_date>
  <is_week_day>true</is_week_day>
  <is_week_of_month>true</is_week_of_month>
  <month_day_range>sample string 11</month_day_range>
  <month_list>sample string 7</month_list>
  <repeat_after_days>1</repeat_after_days>
  <repeat_after_weeks>1</repeat_after_weeks>
  <report_id>1</report_id>
  <report_name>sample string 2</report_name>
  <report_output_format>sample string 18</report_output_format>
  <report_parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </report_parameters>
  <schedule_time>sample string 12</schedule_time>
  <schedule_type>Daily</schedule_type>
  <start_schedule_date>sample string 13</start_schedule_date>
  <stop_schedule_date>sample string 15</stop_schedule_date>
  <subject>sample string 17</subject>
  <subscription_id>sample string 3</subscription_id>
  <week_days_list>sample string 5</week_days_list>
  <week_of_month>sample string 9</week_of_month>
</SSRSReportSubscriptionItemModel>

multipart/form-data

Sample:

<SSRSReportSubscriptionItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><email_to>sample string 16</email_to><is_repeat_after_days>true</is_repeat_after_days><is_runs_on_specific_days>true</is_runs_on_specific_days><is_stop_schedule_date>true</is_stop_schedule_date><is_week_day>true</is_week_day><is_week_of_month>true</is_week_of_month><month_day_range>sample string 11</month_day_range><month_list>sample string 7</month_list><repeat_after_days>1</repeat_after_days><repeat_after_weeks>1</repeat_after_weeks><report_id>1</report_id><report_name>sample string 2</report_name><report_output_format>sample string 18</report_output_format><report_parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"><d2p1:KeyValuePairOfstringstring><d2p1:key>sample string 1</d2p1:key><d2p1:value>sample string 2</d2p1:value></d2p1:KeyValuePairOfstringstring><d2p1:KeyValuePairOfstringstring><d2p1:key>sample string 1</d2p1:key><d2p1:value>sample string 2</d2p1:value></d2p1:KeyValuePairOfstringstring></report_parameters><schedule_time>sample string 12</schedule_time><schedule_type>Daily</schedule_type><start_schedule_date>sample string 13</start_schedule_date><stop_schedule_date>sample string 15</stop_schedule_date><subject>sample string 17</subject><subscription_id>sample string 3</subscription_id><week_days_list>sample string 5</week_days_list><week_of_month>sample string 9</week_of_month></SSRSReportSubscriptionItemModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:

true

application/xml, text/xml, multipart/form-data

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>