ECGridOS API v4
Click here for a complete list of operations.
UserInfo
Detail for a specified User.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/UserInfo" <?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> <UserInfo xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <UserID>int</UserID> </UserInfo> </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> <UserInfoResponse xmlns="https://os.ecgrid.io/"> <UserInfoResult> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <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> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </UserInfoResult> </UserInfoResponse> </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> <UserInfo xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <UserID>int</UserID> </UserInfo> </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> <UserInfoResponse xmlns="https://os.ecgrid.io/"> <UserInfoResult> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <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> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </UserInfoResult> </UserInfoResponse> </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/UserInfo?SessionID=string&UserID=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"?> <UserIDInfo xmlns="https://os.ecgrid.io/"> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <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> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </UserIDInfo>
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/UserInfo HTTP/1.1 Host: os.ecgrid.io Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&UserID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <UserIDInfo xmlns="https://os.ecgrid.io/"> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <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> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </UserIDInfo>