SdkRequest Class

Applies To: Dynamics Marketing

Represents the abstract base class for all SDK request messages.

Namespace:   Microsoft.Dynamics.Marketing.SDK.Common
Assembly:  Microsoft.Dynamics.Marketing.SDK (in Microsoft.Dynamics.Marketing.SDK.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Dynamics.Marketing.SDK.Common.SdkMessage
    Microsoft.Dynamics.Marketing.SDK.Common.SdkRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Category.CreateOrUpdateCustomFieldCategoriesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Category.RetrieveCategoryValuesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.ActivateCompanyRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.CreateOrUpdateCompanyRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.DeleteCompanyRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.RetrieveCompaniesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Company.RetrieveCompanyRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.ActivateContactRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.CreateOrUpdateContactsWithResultsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.DeleteContactRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.PartialContactsUpdateRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.PartialContactUpdateRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveContactRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveContactsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveCurrenciesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveLanguagesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Contact.RetrieveSalutationsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.CustomField.RetrieveCustomFieldsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMarketingResult.RetrieveEmailMarketingResultsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveCommercialEmailMessagesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveContactPermissionsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveEmailMessageSentStatusRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveEmailMessagesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveMessageSchemaForEmailMessageRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveMissingContactPermissionsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.RetrieveUnprocessedEmailHardBouncesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SendCommercialEmailMessageByIdRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SendEmailMessageByEmailRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SendEmailMessageByIdRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetContactPermissionsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetContactsPermissionsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.EmailMessage.SetEmailHardBouncesToProcessedForContactRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CancelEventAttendanceRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CancelEventRegistrationRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CreateOrUpdateEventAttendanceRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.CreateOrUpdateEventRegistrationRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendanceRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendancesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventAttendanceStatusesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventRegistrationRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Event.RetrieveEventRegistrationsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.CreateOrUpdateExternalEntityRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.DeleteExternalEntityRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.DeleteExternalEntityTypeRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalEntityRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalEntityTypesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.ExternalEntity.RetrieveExternalIdsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Landingpage.RetrieveSubmissionRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.CreateOrUpdateLeadRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.DeleteLeadRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadPrioritiesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadStatusesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveSalesRatingsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveTerritoriesRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactsToMarketingListByEmailsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactsToMarketingListByIdsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactToMarketingListByEmailRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.AddContactToMarketingListByIdRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CopyContactsFromMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CopyQueryToMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.CreateMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.DeleteMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveAllContactsFromMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveContactFromMarketingListByEmailRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RemoveContactFromMarketingListByIdRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveAllListsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.RetrieveMarketingListsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingList.UpdateMarketingListRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.CreateOrUpdateMarketingResultRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.CreateOrUpdateMarketingResultsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.DeleteMarketingResultRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.PartialUpdateMarketingResultRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.PartialUpdateMarketingResultsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultsRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.MarketingResult.RetrieveMarketingResultTypesRequest

Syntax

[DataContractAttribute]
public abstract class SdkRequest : SdkMessage

[DataContractAttribute]
public ref class SdkRequest abstract : SdkMessage

[<AbstractClass>]
[<DataContractAttribute>]
type SdkRequest = 
    class
        inherit SdkMessage
    end

<DataContractAttribute>
Public MustInherit Class SdkRequest
    Inherits SdkMessage

Constructors

	Name	Description
	SdkRequest()	Initializes a new instance of the SdkRequest class.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	FromBrokeredMessage(BrokeredMessage)	Deserializes and decompresses the SdkMessage from the body of the brokered message.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToBrokeredMessage()	Creates a new brokered message with the compressed and serialized SdkMessage.(Inherited from SdkMessage.)
	ToBrokeredMessage(String)	Creates a new brokered message with the compressed and serialized SdkMessage.
	ToString()	(Inherited from Object.)

Remarks

These are messages that the third-party client will put on the SDK request queue that the customer has configured to send messages to Microsoft Dynamics Marketing.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

SdkResponse
SdkMessage
Microsoft.Dynamics.Marketing.SDK.Common Namespace
Sample: Manage lists and send transactional or commercial email
Sample: Work with marketing lists
Introduction to marketing entities

Return to top