Aspirant API [beta]

GET

  • The GET method displays the all aspirant members inside the domain. 

GET developer.viadesk.com/api/aspirant?status=accepted…

  • Parameter offset represents the offset of the list, default is empty.
  • Parameters limit determines the length of the list, default is empty. 
  • Parameter status can be used to filter the Aspirants with their status. Values can be accepted or rejected. Default is empty.

 
Example response body response:
[
  {
    "id": "1159372-6173706972616e74",
    "kind": "aspirant",
    "name": "Sean Connery",
    "rejected": false,
    "offices": [
      "6880-6f6666696365"
    ],
    "firstname": "Sean",
    "lastname": "Connery",
    "title": "Secret agent",
    "email": "sean@secretmail.com",
    "cellphone": "0612345678",
    "jobtitle": "License to chill",
    "category": "Categorie 3",
    "locale": "nl_NL",
    "customContact1": "laatste optie",
    "customContact4": "Ja",
    "created": "2023-11-27T14:15:18+0100",
    "modified": "2023-11-27T14:15:18+0100",
    "body": "

",
    "diggsPositive": 0,
    "diggsNegative": 0,
    "featured": false,
    "canAddChildren": true,
    "canWrite": true,
    "canAll": true,
    "isLiked": false
  },{
    "id": "1159333-6173706972616e74",
    "kind": "aspirant",
    "name": "Lois Lane",
    "rejected": false,
    "offices": [
      "7080-6f6666696365"
    ],
    "firstname": "Lois",
    "lastname": "Lane",
    "email": "llane@superhero.com",
    "locale": "nl_NL",
    "customContact1": "55666",
    "customContact4": "Weet niet",
    "created": "2023-11-27T14:10:03+0100",
    "modified": "2023-11-27T14:10:03+0100",
    "body": "

",
    "diggsPositive": 0,
    "diggsNegative": 0,
    "featured": false,
    "canAddChildren": true,
    "canWrite": true,
    "canAll": true,
    "isLiked": false
  }
]

POST

  • A successful create or update returns the response code 200.

POST projecten.viadesk.com/api/aspirant.json
form field “id” // id of the aspirant you want to create or update, or accept 
form field “acceptaspirant” // value true if you would like to accept this Aspirant and turn him/her into a User. This step cannot be undone!

form field “offices” // a list of office ids the Aspirant wants to become member of
form field “firstname” // a string to update the firstname
form field “prefix” // a string to update the prefix
form field “lastname” // a string to update the lastname
form field “email” // a string to update the email
form field “phone” // a string to update the phone
form field “cellphone” // a string to update the cellphone
form field “fax” // a string to update the fax
form field “company” // a string to update the company
form field “department” // a string to update the department
form field “jobtitle” // a string to update the jobtitle
form field “companyaddress1” // a string to update the companyaddress1
form field “companyaddress2” // a string to update the companyaddress2
form field “companyzip” // a string to update the companyzip
form field “companycity” // a string to update the companycity
form field “companycountry” // a string to update the companycountry
form field “visitaddress1” // a string to update the visitaddress1
form field “visitaddress2” // a string to update the visitaddress2
form field “visitzip” // a string to update the visitzip
form field “visitcity” // a string to update the visitcity
form field “visitcountry” // a string to update the visitcountry
form field “category” // a string to update the category
form field “division” // a string to update the division
form field “title” // a string to update the title
form field “locale” // a string to update the locale

DELETE

  • The DELETE method allows you to delete the Aspirant. Only if the user has the required permission.
  • A successful DELETE returns response code 200.

DELETE projecten.viadesk.com/api/aspirant.json?id=6…

form field “id” // id of the member, a required field.