POST api/Identity/Validate/{affiliateId}

Validates an identity with an affiliates own identity provider and authorization system

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId	The affiliate id	integer	Required
v	The requested API version	string	Required Default value is 1

Name

Description

Type

Additional information

affiliateId

The affiliate id

integer

Required

The requested API version

string

Required

Default value is 1

Body Parameters

Mandatory for Eircom: EFibreNumber, IpAddress, MacAddress

FilmFlex.Platform.Common.API.Contracts.V2.AGS.ValidateIdentityParametersDTO

Name	Description	Type	Additional information
ActionType	The type of get identity method to perform	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.ValidateActionType	None.
ParametersDictionary	The set of parameters to pass	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "ActionType": 0,
  "ParametersDictionary": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

Response Information

Resource Description

Validates an identity with an affiliates own identity provider and authorization system

FilmFlex.Platform.Common.API.Contracts.V2.AGS.ValidateIdentityResultDTO

Name	Description	Type	Additional information
CustomerName	The customer name as known on the affiliate system	string	None.
UniqueIdentifier	Vu Platform internal username (account name). Gets resolves and populated by the Membership Provider	string	None.
EMailAddress	The account number as known on the affiliates system	string	None.
VuAccountResolutionMethod	Indicates how to resolve (lookup) a Vu Platform user account based on the Affiliates own internal unique account reference.	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.PlatformAccountResolutionMethod	None.
Token	The Users Token / Session Id	string	None.
IdentityStatusCode	The users Identity Status Code as given by the affiliates system	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.ValidateIdentityStatusCode	None.
IdentityStatus	The users Identity Status as given by the affiliates system	string	None.
CustomerTVODProduct	The customers product as known on the affiliates system	string	None.
TVODStatusCode	The users TVOD Status Code as given by the affiliates system	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.TvodEligibleStatusCode	None.
TVODStatus	The users TVOD Status as given by the affiliates system	string	None.
CustomerSVODProduct	The customers product as known on the affiliates system	string	None.
SVODStatusCode	The users SVOD Status Code as given by the affiliates system	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.SvodEligibleStatusCode	None.
SVODStatus	The users SVOD Status as given by the affiliates system	string	None.
ESTStatusCode	The users EST Status Code as given by the affiliates system	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.EstEligibleStatusCode	None.
ESTStatus	The users EST Status as given by the affiliates system	string	None.
SubscriptionTiers	A CSV list of Offer related subscriptions that this customer has	string	None.
TermsAndConditionsAccepted	Have the Terms and Conditions been accepted	boolean	None.
PortalStatus	The resultant status of the portal account	FilmFlex.Platform.Common.API.Contracts.V2.AGS.ValidateIdentityResultDTO+PortalUserStatus	None.
AffiliateStatus	The resultant status a customer has in the affiliate's system	FilmFlex.Platform.Common.API.Contracts.V2.AGS.Enums.AffiliateStatusCode	None.
AffiliateId	Identifier of the affiliate	integer	None.
AutoActivateUser	Gets or sets a value indicating whether to automaticly activate user..	boolean	None.
OAuthToken		string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerName": "sample string 1",
  "UniqueIdentifier": "sample string 2",
  "EMailAddress": "sample string 3",
  "VuAccountResolutionMethod": 0,
  "Token": "sample string 4",
  "IdentityStatusCode": 0,
  "IdentityStatus": "sample string 5",
  "CustomerTVODProduct": "sample string 6",
  "TVODStatusCode": 0,
  "TVODStatus": "sample string 7",
  "CustomerSVODProduct": "sample string 8",
  "SVODStatusCode": 0,
  "SVODStatus": "sample string 9",
  "ESTStatusCode": 0,
  "ESTStatus": "sample string 10",
  "SubscriptionTiers": "sample string 11",
  "TermsAndConditionsAccepted": true,
  "PortalStatus": 0,
  "AffiliateStatus": 0,
  "AffiliateId": 13,
  "AutoActivateUser": true,
  "OAuthToken": "sample string 15"
}