POST example/api/login/createeditmailmessageticket

https://app.bwz.se/bedrock/example/api/login/createeditmailmessageticket

Creates a login ticket which allows a user to edit a specified MailMessage.

Request Information

URI Parameters

None.

Body Parameters

Settings for the ticket login behavior. When set to null the default TicketLoginBehavior TicketLoginBehavior.UseExistingSessionFallbackToTicketCredentials will be used

CreateEditMailMessageTicketArgs
NameDescriptionTypeAdditional information
MailMessageId

The id of the mail message to edit

integer

Required

HeaderState

Presentation setting for the whole header

FlowItemState

None.

StartTab

Determine what tab the user will start on

MailMessageFlowMenuPages

None.

Tabs

Presentation settings for the tabs

MailMessageTabs

None.

TicketLoginCredentials

Settings for the ticket login behavior. When set to null the default TicketLoginBehavior TicketLoginBehavior.UseExistingSessionFallbackToTicketCredentials will be used

TicketLoginCredentials

None.

Request Formats

application/json, text/json

Sample:
{
  "MailMessageId": 1,
  "HeaderState": 0,
  "StartTab": 0,
  "Tabs": {
    "Settings": {
      "TabState": 0
    },
    "Content": {
      "Toolbar": {
        "SendTestRecipientInformation": [
          "sample string 1",
          "sample string 2"
        ],
        "SaveButton": 0,
        "LockSendTestRecipientInformation": true,
        "LockSendTestSendingDomain": true
      },
      "TabState": 0
    },
    "Recipients": {
      "TabState": 0
    },
    "Integration": {
      "TabState": 0
    },
    "Send": {
      "TabState": 0
    },
    "Close": {
      "TabState": 0
    }
  },
  "TicketLoginCredentials": {
    "UserEmail": "sample string 1",
    "LoginBehavior": 1
  }
}

application/xml, text/xml

Sample:
<CreateEditMailMessageTicketArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Login">
  <TicketLoginCredentials>
    <LoginBehavior>UseTicketCredentials</LoginBehavior>
    <UserEmail>sample string 1</UserEmail>
  </TicketLoginCredentials>
  <HeaderState>Default</HeaderState>
  <MailMessageId>1</MailMessageId>
  <StartTab>Default</StartTab>
  <Tabs>
    <Close>
      <TabState>Default</TabState>
    </Close>
    <Content>
      <TabState>Default</TabState>
      <Toolbar>
        <LockSendTestRecipientInformation>true</LockSendTestRecipientInformation>
        <LockSendTestSendingDomain>true</LockSendTestSendingDomain>
        <SaveButton>Default</SaveButton>
        <SendTestRecipientInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </SendTestRecipientInformation>
      </Toolbar>
    </Content>
    <Integration>
      <TabState>Default</TabState>
    </Integration>
    <Recipients>
      <TabState>Default</TabState>
    </Recipients>
    <Send>
      <TabState>Default</TabState>
    </Send>
    <Settings>
      <TabState>Default</TabState>
    </Settings>
  </Tabs>
</CreateEditMailMessageTicketArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An url to open the mail message for edit

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>