Platform API

UpdateObjectSubscrptionStatus

Updates an object subscription status

The following routes are available for this service:
All Verbs	/api/updateobjectsubscriptionstatus

**UpdateObjectSubscrptionStatus** Parameters:
Name	Parameter	Data Type	Required
ObjectSubscriptionId	query	Guid	No
RecordStatus	query	Char	No
SubscriptionKey	query	string	No

**GetDataSourcesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DataSources	form	List<ListDataItem>	No
ResponseStatus	form	ResponseStatus	No

**ListDataItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Description	form	string	No
ShortName	form	string	No
DefaultName	form	string	No
IsDefault	form	bool	No
Order	form	int	No
ListItemTrafficLightId	form	Guid	No
PrimaryListItemImageId	form	Guid	No
PrimaryListItemImageUrl	form	string	No
PrimaryImageThumbnailUrl	form	string	No
OwnerContactId	form	Guid	No
RecordStatus	form	string	No
Tags	form	string	No
ListId	form	Guid	No
MarkAsChecked	form	bool	No
RelatedObjectId	form	Guid	No
CanEdit	form	bool	No
IsOwner	form	bool	No
ExtraValues	form	List<Object>	No
ListItemFilters	form	List<ListItemFilter>	No

**ListItemFilter** Parameters:
Name	Parameter	Data Type	Required
ListItemFilterId	form	Guid	No
FilterName	form	string	No
ListId	form	Guid	No
ListItemId	form	Guid	No
ListItemIsInFilter	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/updateobjectsubscriptionstatus HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecordStatus: ,
	SubscriptionKey: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DataSources: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			DefaultName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String,
			Tags: String,
			MarkAsChecked: False,
			CanEdit: False,
			IsOwner: False,
			ExtraValues: 
			[
				{
					
				}
			],
			ListItemFilters: 
			[
				{
					FilterName: String,
					ListItemIsInFilter: False
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}