Get Profiles

Release Time

06/07/2018

Views

2906 times

Key	Value	Description
Http method	GET	Http method
Content-Type	application/json
x-auth-type	4	Authentication type identifier
x-auth-token	access token	3rd Party Authentication Token

Execution

Sample execution can be handled via Postman Application.

​

Header part can be handled via Postman Application

​

Success Output

{
  "title": "Response of profiles",
  "type": "object",
  "properties": {
    "search": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "page_size": {
          "type": "number",
          "description": "Current page size"
        }
      }
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Profile identifier"
          },
          "name": {
            "type": "string",
            "description": "Profile name"
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              4
            ],
            "description": "1 - Android, 2 - iOS, 3 - Windows, 4 - macOS"
          }
        }
      }
    }
  }
}

 
{
  "title": "Response of profiles",
  "type": "object",
  "properties": {
    "search": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "page_size": {
          "type": "number",
          "description": "Current page size"
        }
      }
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Profile identifier"
          },
          "name": {
            "type": "string",
            "description": "Profile name"
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              4
            ],
            "description": "1 - Android, 2 - iOS, 3 - Windows, 4 - macOS"
          }
        }
      }
    }
  }
}

Error Output

Possible  HTTP codes
200	      Ok.
400	      Bad request
401	      Unauthorized
403   	  Forbidden
404	      Not found

 
Possible  HTTP codes
     Ok.
     Bad request
     Unauthorized
      Forbidden
     Not found
​

Param Name	Description	Limitations
page	interested page
page-size	how many results in answer	max is 200