Skip to content

UserAdd

Jump to bottom
Lee Bolgatz edited this page Oct 28, 2022 · 2 revisions

Back To Common API Calls

Create a User for the Session Network and a specified Mailbox.

  public int UserAdd(string SessionID,
                     int MailboxID,
                     string LoginName,
                     string Password,
                     string RecoveryQuestion,
                     string RecoveryAnswer,
                     string FirstName,
                     string LastName,
                     string Company,
                     string EMail,
                     string Phone,
                     string CellPhone,
                     CellCarrier CellCarrier,
                     AuthLevel AuthLevel)

Parameters

Returns

int

Remarks

This will add a new user to the Session Network/Mailbox. The maximum Authorization Level is that of the current Session UserID.

To add users to other Network/Mailboxes use UserAddEx().

Code Example

C#

using System.Xml;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            int MailboxID = 5684456;
            string LoginName = "UserLoginName";
            string Password = "Password";
            string RecoveryQuestion = "Question";
            string RecoveryAnswer = "Answer";
            string FirstName = "FirstName";
            string LastName = "LastName";
            string Company = "CompanyName";
            string EMail = "person@domain.com";
            string Phone = "1234567890";
            string CellPhone = "0987654321";

            int UserResults= ECGrid.UserAdd(SessionID, MailboxID, LoginName, Password, RecoveryQuestion, RecoveryAnswer, FirstName, LastName, Company, EMail, Phone, CellPhone, ECGridService.CellCarrier.ATT, ECGridService.AuthLevel.NetworkAdmin);

        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/UserAdd"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserAdd xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <MailboxID>int</MailboxID>
      <LoginName>string</LoginName>
      <Password>string</Password>
      <RecoveryQuestion>string</RecoveryQuestion>
      <RecoveryAnswer>string</RecoveryAnswer>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Company>string</Company>
      <EMail>string</EMail>
      <Phone>string</Phone>
      <CellPhone>string</CellPhone>
      <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
      <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    </UserAdd>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserAddResponse xmlns="https://os.ecgrid.io/">
      <UserAddResult>int</UserAddResult>
    </UserAddResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserAdd xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <MailboxID>int</MailboxID>
      <LoginName>string</LoginName>
      <Password>string</Password>
      <RecoveryQuestion>string</RecoveryQuestion>
      <RecoveryAnswer>string</RecoveryAnswer>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Company>string</Company>
      <EMail>string</EMail>
      <Phone>string</Phone>
      <CellPhone>string</CellPhone>
      <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
      <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    </UserAdd>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserAddResponse xmlns="https://os.ecgrid.io/">
      <UserAddResult>int</UserAddResult>
    </UserAddResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v4.1/prod/ECGridOS.asmx/UserAdd?SessionID=string&MailboxID=string&LoginName=string&Password=string&RecoveryQuestion=string&RecoveryAnswer=string&FirstName=string&LastName=string&Company=string&EMail=string&Phone=string&CellPhone=string&CellCarrier=string&AuthLevel=string HTTP/1.1
Host: os.ecgrid.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="https://os.ecgrid.io/">int</int>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx/UserAdd HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&MailboxID=string&LoginName=string&Password=string&RecoveryQuestion=string&RecoveryAnswer=string&FirstName=string&LastName=string&Company=string&EMail=string&Phone=string&CellPhone=string&CellCarrier=string&AuthLevel=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="https://os.ecgrid.io/">int</int>

Back To Common API Calls

Home

Getting Started

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally