Profiles Resource

Profiles contain all customer data. Eg. username, email.

List Profiles

Return a list of all accesible profiles.

GET /rest/profiles

Response

[
    {
        "id": 1,
        "_links": {
            "href": "https://d9tready.com/rest/profiles/1",
            "rel": "self"
        }
    },
    ...
]

Attributes

• id - Unique resource identifier.

Link relations

• self - Access to Profiles Resource.

HTTP Status Codes

Status Code	Description
200 OK	No error, operation successful
403 FORBIDDEN	Authentication failure

Retrieve Profile

Retrieve a single profile resource.

GET /rest/profiles/1

Response

{
    "username": "demo",
    "vatNo": "DE1234567890",
    "address": "Musterstr. 123",
    "salutation": "m",
    "fullName": "Max Mustermann",
    "id": 38,
    "invoiceable": true,
    "city": "Musterhausen",
    "mobile": "",
    "country": "DE",
    "dateOfBirth": "1970-01-01",
    "postalCode": "12345",
    "email": "demo@d9tready.com"
}

Attributes

• username - Username
• vatNo - VAT No. Only for EU customers.
• address - Postal address.
• salutation - Salutation (m/f).
• fullName - Full name.
• id - Unique resource identifier.
• invoiceable - Check if profile is complete and invoiceable.
• city - City.
• mobile - Mobile phone.
• country - Country.
• dateOfBirth - Date of birth.
• postalCode - Postal code.
• email - Email address.

HTTP Status Codes

Status Code	Description
200 OK	No error, operation successful
403 FORBIDDEN	Authentication failure
404 NOT FOUND	Resource not found