GetAgent
From The Contingency Market
Contents |
GetAgent(ulSessionID,uSequenceID,sIntegrity,sAgentID)
Gets a specific agent.
PARAMETERS
-
ulong ulSessionID - ID of authenticated session.
-
uint uSequenceID - Sequence number.
-
string sIntegrity -
md5("ipaddr(sid,seq)->GetAgent(sAgentID)/secret"). -
string sAgentID - Unique ID of Agent.
RETURNS
{sID,sDisplayName,sRegistered,sPublicDetails,uVerificationLevel,sPrivateDetails}
-
string sID - 32 digit hex representing Agent's globally unique id.
-
string sDisplayName - Agent's display name.
-
string sRegistered - yyyy-mm-dd HH:mm:ss (date Agent registered).
-
string sPublicDetails - PHP assoc array (list of name/value pairs) of miscellaneous Agent info.
-
string uVerificationLevel - 0 if unverified, 1 if agent's e-mail verified.
-
string sPrivateDetails - PHP assoc array of private info (only if UID is this session's authenticated agent).
FAULTS
Session.
TEST
GetAgent(693e0883d3a6417a81efba606184751e) according to the respective template currently returns
- ID: 693e0883d3a6417a81efba606184751e
- Name: Crosbie Fitch
- Registered: 2008-01-24T19:30:17.2070000Z
- Public Details:
- Verification Level: 2
- Private Details: .
By way of demonstrating an API error if we supply a bad ID, GetAgent(01234567890123456789012345678901) currently returns 'System.Web.Services.Protocols.SoapException: Agent ID not found
at ContingencyMarketService.Service.ValidateAgent(String sAgentID) in http://server/api/App_Code/Service.cs:line 3268 at ContingencyMarketService.Service.GetAgent(UInt64 ulSessionID, UInt32 uSequenceID, String sIntegrity, String sAgentID) in http://server/api/App_Code/Service.cs:line 330'.
