RetrieveWeatherSubscriptionByDatasourceId

 

DatasourceService / RetrieveWeatherSubscriptionByDatasourceId

 

Description: Get Weather Subscriptions by datasource id

URL: http://{your-server-url}/api/v1/core/datasources/{datasourceid}/weathers/subscriptions

Method: GET

Token Required: True


Request Headers:
currentaccountid: {accountid - optional and default value is user's own account}
content-type: application/json or content-type: application/xml
token: {token}
Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator, Widget Manager

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right Require
Widget_Management Yes
Application_Management Yes

Request Query Parameters:
Parameter Type Nullable Description
rpp int True records per page, default = 50, max = 500
page int True page number

Example: http://{your-server-url}/api/v1/core/datasources/{datasourceid}/weathers/subscriptions?rpp=100&page=100


Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource.DatasourceResponse

Parameter Type
Response.WeatherSubscriptions Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Weather.WeatherSubscription[]
Response.CurrentPage int
Response.TotalPages int
Response.Rpp int

The following is an example response Xml body:
<DatasourceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
  <WeatherSubscriptions xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Weather">
    <a:WeatherSubscription>
      <a:City>String</a:City>
      <a:Country>String</a:Country>
      <a:Forecast>123</a:Forecast>
      <a:Id>123</a:Id>
      <a:State>String</a:State>
      <a:WeatherDataSourceId>123</a:WeatherDataSourceId>
      <a:Zip>String</a:Zip>
      <a:additionalInfos xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:additionalInfos>
    </a:WeatherSubscription>
  </WeatherSubscriptions>
</DatasourceResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123,
	"WeatherSubscriptions":[
		{
			"City":"String",
			"Country":"String",
			"Forecast":123,
			"Id":123,
			"State":"String",
			"WeatherDataSourceId":123,
			"Zip":"String",
			"additionalInfos":[
				{
					"Key":"String",
					"Value":"String"
				}
			]
		}
	]
}