POST api/SaveUsers

Request Information

URI Parameters

None.

Body Parameters

SaveUsersModel
NameDescriptionTypeAdditional information
Users

Collection of UserInfo

None.

ApplicationId

integer

None.

ApplicationSecretKey

string

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Users": [
    {
      "ExternalUserId": "sample string 1",
      "FirstName": "sample string 2",
      "FullName": "sample string 3",
      "MobileNumber": "sample string 4",
      "Email": "sample string 5",
      "Groups": [
        {
          "GroupId": 1,
          "GroupKey": "sample string 1",
          "IsEnabled": true
        },
        {
          "GroupId": 1,
          "GroupKey": "sample string 1",
          "IsEnabled": true
        }
      ]
    },
    {
      "ExternalUserId": "sample string 1",
      "FirstName": "sample string 2",
      "FullName": "sample string 3",
      "MobileNumber": "sample string 4",
      "Email": "sample string 5",
      "Groups": [
        {
          "GroupId": 1,
          "GroupKey": "sample string 1",
          "IsEnabled": true
        },
        {
          "GroupId": 1,
          "GroupKey": "sample string 1",
          "IsEnabled": true
        }
      ]
    }
  ],
  "ApplicationId": 1,
  "ApplicationSecretKey": "sample string 2"
}

application/xml, text/xml

Sample:
<SaveUsersModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.Web.Models.API">
  <ApplicationId>1</ApplicationId>
  <ApplicationSecretKey>sample string 2</ApplicationSecretKey>
  <Users>
    <UserInfo>
      <Email>sample string 5</Email>
      <ExternalUserId>sample string 1</ExternalUserId>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 3</FullName>
      <Groups xmlns:d4p1="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.DAL">
        <d4p1:CustomerGroupUpdateModel>
          <d4p1:GroupId>1</d4p1:GroupId>
          <d4p1:GroupKey>sample string 1</d4p1:GroupKey>
          <d4p1:IsEnabled>true</d4p1:IsEnabled>
        </d4p1:CustomerGroupUpdateModel>
        <d4p1:CustomerGroupUpdateModel>
          <d4p1:GroupId>1</d4p1:GroupId>
          <d4p1:GroupKey>sample string 1</d4p1:GroupKey>
          <d4p1:IsEnabled>true</d4p1:IsEnabled>
        </d4p1:CustomerGroupUpdateModel>
      </Groups>
      <MobileNumber>sample string 4</MobileNumber>
    </UserInfo>
    <UserInfo>
      <Email>sample string 5</Email>
      <ExternalUserId>sample string 1</ExternalUserId>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 3</FullName>
      <Groups xmlns:d4p1="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.DAL">
        <d4p1:CustomerGroupUpdateModel>
          <d4p1:GroupId>1</d4p1:GroupId>
          <d4p1:GroupKey>sample string 1</d4p1:GroupKey>
          <d4p1:IsEnabled>true</d4p1:IsEnabled>
        </d4p1:CustomerGroupUpdateModel>
        <d4p1:CustomerGroupUpdateModel>
          <d4p1:GroupId>1</d4p1:GroupId>
          <d4p1:GroupKey>sample string 1</d4p1:GroupKey>
          <d4p1:IsEnabled>true</d4p1:IsEnabled>
        </d4p1:CustomerGroupUpdateModel>
      </Groups>
      <MobileNumber>sample string 4</MobileNumber>
    </UserInfo>
  </Users>
</SaveUsersModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResult
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Error

string

None.

ErrorDetails

string

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "IsSuccess": true,
  "Error": "sample string 2",
  "ErrorDetails": "sample string 3"
}

application/xml, text/xml

Sample:
<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaSoft.Notifications.Web.Models.API">
  <Error>sample string 2</Error>
  <ErrorDetails>sample string 3</ErrorDetails>
  <IsSuccess>true</IsSuccess>
</APIResult>