ECGridOS API v4


Click here for a complete list of operations.

UserAdd

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

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
MailboxID:
LoginName:
Password:
RecoveryQuestion:
RecoveryAnswer:
FirstName:
LastName:
Company:
EMail:
Phone:
CellPhone:
CellCarrier:
AuthLevel:

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>