User resource

Methods

  • post - Add a new user to your addressbook
  • post - Assign a user to a rental
  • get - Get a user from your addressbook
  • get - Get rental user
  • get - List users in your addressbook (paginated)
  • put - Update a user from your addressbook

Resource

{
    "addressCity": "string",
    "addressCountry": {
        "code": "string",
        "name": "string"
    },
    "addressPostalCode": "string",
    "addressState": "string",
    "addressStreet1": "string",
    "addressStreet2": "string",
    "birthDate": "date",
    "civility": "string",
    "creationDatetime": "date-time",
    "deactivated": "boolean",
    "email": "email",
    "firstName": "string",
    "id": "integer",
    "landlinePhone": "string",
    "language": {
        "code": "string",
        "name": "string"
    },
    "lastModificationDatetime": "date-time",
    "lastName": "string",
    "mobilePhone": "string",
    "nationality": {
        "code": "string",
        "name": "string"
    },
    "organizationName": "string",
    "organizationType": "string",
    "organizationVatNumber": "string"
}

Properties

Name Type Description Additional
addressCity string

User city of residence
addressCountry object

Country information.
addressCountry.code string

Country code

 Optional, read only.
addressCountry.name string

Country name

 Optional, read only.
addressPostalCode string

User postal code of residence
addressState string

User state of residence
addressStreet1 string

User address street 1 of residence
addressStreet2 string

User address street 2 of residence

 Optional
birthDate date

User date of birth
civility string

User civility (accepted values are MS, MR, OTHER)
creationDatetime date-time

User creation date-time

 Optional, read only.
deactivated boolean

TRUE if a profile is deactivated or blocked.

 Optional, read only.
email email

User email
firstName string

User first name
id integer

User ID

 Optional, read only.
landlinePhone string Phone
language object

User language
language.code string

Standard language code
language.name string

Language name
lastModificationDatetime date-time

User last update date-time

 Optional, read only.
lastName string

User last name
mobilePhone string Phone
nationality object

Country information.
nationality.code string

Country code

 Optional, read only.
nationality.name string

Country name

 Optional, read only.
organizationName string

Organization name. Necessary if the user represents an association or a society

 Optional
organizationType string

User can be an individual or can represent an association or a society (accepted values are INDIVIDUAL, SOCIETY, ASSOCIATION)
organizationVatNumber string

Organization VAT number. Necessary if the user represents an association or a society

 Optional