AIM Web Services

<back to all web services

PasswordRequest

Service for changing passwords

The following routes are available for this service:
POST, GET/api/Password
POST, GET/api/Password/{action}
PasswordRequest Parameters:
NameParameterData TypeRequiredDescription
ActionpathstringNo
UsernamebodystringNo
PasswordTokenbodystringNo
PasswordbodystringNo
PasswordResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Password HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Action":"String","Username":"String","PasswordToken":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Response":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}