XML Post API

Warning

This API method is under development, there may be changes to it. Please contact your customer representative to access the API method.

You can follow the instructions below to get the list of groups defined in your directory in XML format using the POST method of the HTTP protocol.

Address to request

POSThttps://api.iletimerkezi.com/v1/get-groups

Request Content (Body)

Content of the request if you are using username and password

<request>
  <authentication>
    <username></username>
    <password></password>
  </authentication>
</request>

Content of the request if you are processing using API Key

<request>
  <authentication>
    <key></key>
    <hash></hash>
  </authentication>
</request>

Definitions

The request to the server must be wrapped with the request tag. The definitions of the subtags of this tag are as follows:

authentication

It is the user information that must be sent in order to receive authorization for the requested operation. The alt tags are as follows:

Username

• username: is the user name used when logging into transmissionerkezi.com. The mobile phone number you used while registering. It is required to be sent when making a request.
• password is the password used when logging into transmissionerkezi.com. It is required to be sent when making a request.

API Key

• key: API Key that you can create from the settings section should be written in this field after logging in to your transmissionerkezi.com panel. It is required to be sent when making a request.
• hash: After logging into your transmissioncentre.com panel, the hash generated using the API Key and Secret Key that you can create from the settings section should be written in this field. It is required to be sent when making a request.

Server response

<response>
  <status>
    <code></code>
    <message></message>
  </status>
  <groups>
    <group>
      <id></id>
      <name></name>
      <count></count>
      <children>
        <child>
          <id></id>
          <name></name>
          <count></count>
        </child>
      </children>
    </group>
  <groups>
</response>

Definitions

The response from the server is always wrapped in the response tag. The definition of subtags of this tag is as follows:

status

Contains information about the transaction status. The values ​​returned by this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned by default on every request made. The alt tags are as follows

• code: It is the numerical value that indicates the operation status.
• message: Contains an informational message about the transaction status.

groups

If the operation was completed successfully, it contains the information of the main groups created in your directory. If the operation fails, this tag is not returned. The alt tags are as follows.

• groups

  Contains the group's information. It repeats as many as the defined main group number. The alt tags are as follows.

  • id: Unique value representing the group.

  • name: Contains the name of the group.

  • count: Shows the number of people in the group.

  • children

    The sub-tags that contain the information of the subgroups of the group are as follows.

    • child

      Contains the information of the subgroup of the group, repeats as many as the number of subgroups. The alt tags are as follows.

      • id: Unique value representing the group.
      • name: Contains the name of the group.
      • count: Shows the number of people in the group