auth

Get information about the user type.

Request format

https://adfox.yandex.com/api/v1
  ? object=account
  & action=auth

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <accountID>{integer}</accountID>
  <isAdministrator>{integer}</isAdministrator>
  <isAssistant>{integer}</isAssistant>
  <isAdvertiser>{integer}</isAdvertiser>
  <isWebmaster>{integer}</isWebmaster>
  <eMail>{string}</eMail>
  <groupID>{integer}</groupID>
  <typeID>{integer}</typeID>
</data>
</result>
</response>

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

accountID

Account ID in the Adfox system.

isAdministrator

User type.

Acceptable values:

  • 0: Not an administrator.
  • 1: Administrator.

isAssistant

User type.

Acceptable values:

  • 0: Not an assistant.
  • 1: Assistant.

isAdvertiser

User type.

Acceptable values:

  • 0: Not an advertiser.
  • 1: Advertiser.

isWebmaster

User type.

Acceptable values:

  • 0: Not a site owner.
  • 1: Site owner.

eMail

User's email address.

groupID

ID of the group that the user belongs to.

typeID

Type ID.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=auth

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <accountID>166243</accountID>
  <isAdministrator>1</isAdministrator>
  <isAssistant>0</isAssistant>
  <isAdvertiser>0</isAdvertiser>
  <isWebmaster>0</isWebmaster>
  <eMail>mail@adfox.com</eMail>
  <groupID>3</groupID>
  <typeID>1</typeID>
</data>
</result>
</response>
Previous
category
Next
browser