POST api/Invitation/InviteUsers

Request Information

URI Parameters

None.

Body Parameters

InvitationModel
NameDescriptionTypeAdditional information
AccountKey

string

None.

EmailAddresses

Collection of string

None.

RoleEntities

Collection of RoleEntityModel

None.

RoleId

integer

None.

EntityId

integer

None.

ProductLineId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountKey": "sample string 1",
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleEntities": [
    {
      "RoleId": 1,
      "EntityKeys": [
        "sample string 1",
        "sample string 2"
      ],
      "Fees": 1.0,
      "BranchKey": "sample string 2"
    },
    {
      "RoleId": 1,
      "EntityKeys": [
        "sample string 1",
        "sample string 2"
      ],
      "Fees": 1.0,
      "BranchKey": "sample string 2"
    }
  ],
  "RoleId": 2,
  "EntityId": 3,
  "ProductLineId": 4
}

application/xml, text/xml

Sample:
<InvitationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccountManagement.Models">
  <AccountKey>sample string 1</AccountKey>
  <EmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAddresses>
  <EntityId>3</EntityId>
  <ProductLineId>4</ProductLineId>
  <RoleEntities>
    <RoleEntityModel>
      <BranchKey>sample string 2</BranchKey>
      <EntityKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EntityKeys>
      <Fees>1</Fees>
      <RoleId>1</RoleId>
    </RoleEntityModel>
    <RoleEntityModel>
      <BranchKey>sample string 2</BranchKey>
      <EntityKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EntityKeys>
      <Fees>1</Fees>
      <RoleId>1</RoleId>
    </RoleEntityModel>
  </RoleEntities>
  <RoleId>2</RoleId>
</InvitationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.