API Document
echo/{value} - echo the value back, for testing purpose
helloworld - show some basic information. for testing purpose.
weblogin - when you have SSL, you can do weblogin because password is passed in plain text.
you get back a cookie to use for later use.
Example:
Url : http://localhost:88/rest/usermgmt.svc/weblogin
Input:<?xml version="1.0" encoding="utf-16"?>
<WebLogin xmlns="http://tempuri.org/">
<username>jerry@gladinet.com</username>
<password>dingdong123</password>
</WebLogin>
Output:
Good Login.
<?xml version="1.0" encoding="utf-16"?>
<WebLoginResponse xmlns="http://tempuri.org/">
<WebLoginResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Cookie>mAuCPRfaxmfB2ye6KqJpLJdCeEugkWjft8IgWJsH6LQiZzpM</a:Cookie>
<a:Server>mycloud.gladinet.com</a:Server>
</WebLoginResult>
</WebLoginResponse>
Bad Login:
<?xml version="1.0" encoding="utf-16"?>
<WebLoginResponse xmlns="http://tempuri.org/">
<WebLoginResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>false</a:Success>
<a:Cookie>FAILED:auth</a:Cookie>
<a:Server>null</a:Server>
</WebLoginResult>
</WebLoginResponse>
desktoplogin: - when you don't have SSL, you can do desktoplogin, otherwise it is the same as weblogin.
Example:
Url : http://localhost:88/rest/usermgmt.svc/desktoplogin
Input :<?xml version="1.0" encoding="utf-16"?>
<DesktopLogin xmlns="http://tempuri.org/">
<Username>jerry@gladinet.com</Username>
<Signature>237507169020DA6E07377F9A80A4B1A540CDEB44</Signature>
<Date>2010-12-02 22:38:53Z</Date>
</DesktopLogin>
Output:
<?xml version="1.0" encoding="utf-16"?>
<DesktopLoginResponse xmlns="http://tempuri.org/">
<DesktopLoginResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Cookie>n/jrLIwSaOIMSmO5Pr9sgccjmvEI2tOK8FOnO3ALkTjWCsm7</a:Cookie>
<a:Server>mycloud.gladinet.com</a:Server>
</DesktopLoginResult>
</DesktopLoginResponse>
getmeta - get meta data
Token - the Token can be either a signature or a ticket (cookie) returned.
DomainUser - the user you want to get meta for. omit or "." or "self" means the same user for
Name
Tag
Example:
Url:http://localhost:88/rest/usermgmt.svc/getmeta
Input:
<?xml version="1.0" encoding="utf-16"?>
<GetMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,561D75E1C627304F3E4957D979B91AB0DE0679A8</Token>
<Name>*</Name>
<Tag>*</Tag>
</GetMeta>
Output:
<?xml version="1.0" encoding="utf-16"?>
<GetMetaResponse xmlns="http://tempuri.org/">
<GetMetaResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Result>
<a:Success>true</a:Success>
<a:Reason />
</a:Result>
<a:MetaList>
<a:NamedValue>
<a:Name>a</a:Name>
<a:Value>aa</a:Value>
</a:NamedValue>
<a:NamedValue>
<a:Name>ConnectionLic</a:Name>
<a:Value>0</a:Value>
</a:NamedValue>
</a:MetaList>
</GetMetaResult>
</GetMetaResponse>
Example response of failed request:
<?xml version="1.0" encoding="utf-16"?>
<GetMetaResponse xmlns="http://tempuri.org/">
<GetMetaResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Result>
<a:Success>false</a:Success>
<a:Reason>60C9018BB421BBE4DC67D0DDB2623D6E11746FA6</a:Reason>
</a:Result>
<a:MetaList i:nil="true" />
</GetMetaResult>
</GetMetaResponse>
Example 2 request:
<?xml version="1.0" encoding="utf-16"?>
<GetMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,60C9018BB421BBE4DC67D0DDB2623D6E11746FA6</Token>
<DomainUser>user1@gladinet.com</DomainUser>
<Name>*</Name>
<Tag>*</Tag>
</GetMeta>
Example 2 response:
<?xml version="1.0" encoding="utf-16"?>
<GetMetaResponse xmlns="http://tempuri.org/">
<GetMetaResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Result>
<a:Success>true</a:Success>
<a:Reason />
</a:Result>
<a:MetaList>
<a:NamedValue>
<a:Name>ConnectionLic</a:Name>
<a:Value>0</a:Value>
</a:NamedValue>
</a:MetaList>
</GetMetaResult>
</GetMetaResponse>
putmeta -
Token -
DomainUser
Name
Value
Tag
Example:
URL :http://localhost:88/rest/usermgmt.svc/putmeta
<?xml version="1.0" encoding="utf-16"?>
<PutMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,1EFD6C9BB18FF7DC49A55C7E1087995CDD61DC59</Token>
<Name>ConnectionLic</Name>
<Value>0</Value>
<Tag>CAFS</Tag>
</PutMeta>
Example 1 response:<?xml version="1.0" encoding="utf-16"?>
<PutMetaResponse xmlns="http://tempuri.org/">
<PutMetaResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Reason />
</PutMetaResult>
</PutMetaResponse>
Example 2 request:
<?xml version="1.0" encoding="utf-16"?>
<PutMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,6F271401C8D4DDCB1AB60FE24DBFC72B6CBBFCA7</Token>
<DomainUser>user1@gladinet.com</DomainUser>
<Name>ConnectionLic</Name>
<Value>0</Value>
<Tag>CAFS</Tag>
</PutMeta>
deletemeta
Token -
DomainUser -
Name
Tag
DeleteMetaTest:12/2/2010 6:50:08 PM:http://localhost:88/rest/usermgmt.svc/deletemeta
LogXml:12/2/2010 6:50:08 PM:<?xml version="1.0" encoding="utf-16"?>
<DeleteMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,561D75E1C627304F3E4957D979B91AB0DE0679A8</Token>
<Name>*</Name>
<Tag>*</Tag>
</DeleteMeta>
LogXml:12/2/2010 6:50:08 PM:<?xml version="1.0" encoding="utf-16"?>
<DeleteMetaResponse xmlns="http://tempuri.org/">
<DeleteMetaResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Reason />
</DeleteMetaResult>
</DeleteMetaResponse>
Example 2:
<?xml version="1.0" encoding="utf-16"?>
<DeleteMeta xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,60C9018BB421BBE4DC67D0DDB2623D6E11746FA6</Token>
<DomainUser>user1@gladinet.com</DomainUser>
<Name>*</Name>
<Tag>*</Tag>
</DeleteMeta>
createuser
Token
FirstName
LastName
Email
Password
CreateUserTest:12/2/2010 7:01:39 PM:http://localhost:88/rest/usermgmt.svc/createuser
LogXml:12/2/2010 7:01:39 PM:<?xml version="1.0" encoding="utf-16"?>
<CreateUser xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,CD1F0695AA3BEB15A1A172A402B757E5D8B9E9E2</Token>
<FirstName>abc</FirstName>
<LastName>gladinet</LastName>
<Email>test2@gladinet.com</Email>
<Password>12345</Password>
</CreateUser>
LogXml:12/2/2010 7:01:41 PM:<?xml version="1.0" encoding="utf-16"?>
<CreateUserResponse xmlns="http://tempuri.org/">
<CreateUserResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Reason />
</CreateUserResult>
</CreateUserResponse>
deleteuser
Token
Email
Delete true/false
DeleteUserTest:12/3/2010 2:19:48 PM:http://localhost:88/rest/usermgmt.svc/deleteuser
LogXml:12/3/2010 2:19:48 PM:<?xml version="1.0" encoding="utf-16"?>
<DeleteUser xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,023759F1CEA69AF598CB42C6279D415E81C49FF6</Token>
<Email>test2@gladinet.com</Email>
<Delete>true</Delete>
</DeleteUser>
LogXml:12/3/2010 2:19:51 PM:<?xml version="1.0" encoding="utf-16"?>
<DeleteUserResponse xmlns="http://tempuri.org/">
<DeleteUserResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Success>true</a:Success>
<a:Reason />
</DeleteUserResult>
</DeleteUserResponse>
EnumUser - enum users in the domain
Token -
Tag - if exist, include the tag. if not exist, only list names
EnumUserTest:12/3/2010 2:40:43 PM:http://localhost:88/rest/usermgmt.svc/enumuser
LogXml:12/3/2010 2:40:43 PM:<?xml version="1.0" encoding="utf-16"?>
<EnumUser xmlns="http://tempuri.org/">
<Token>jerry@gladinet.com,C69768897FCE02F4C2FA7E2EC637F94DD9F11367</Token>
<Tag>usr</Tag>
</EnumUser>
LogXml:12/3/2010 2:40:43 PM:<?xml version="1.0" encoding="utf-16"?>
<EnumUserResponse xmlns="http://tempuri.org/">
<EnumUserResult xmlns:a="http://schemas.datacontract.org/2004/07/user" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:DomainUser>
<a:Email>jerry@gladinet.com</a:Email>
<a:Attributes i:nil="true" />
</a:DomainUser>
<a:DomainUser>
<a:Email>user1@gladinet.com</a:Email>
<a:Attributes i:nil="true" />
</a:DomainUser>
</EnumUserResult>
</EnumUserResponse>