Contact
Contact refers to the person of contact for the account.
Properties of a contact
- title: The title to refer to the contact person. Available values are: "Mr." and "Mrs". These values are not translatable in this version of the API.
- initials: The first letter(s) of the first name(s) of the contact person in uppercase.
- first name: First name of the contact person.
- prefix: Prefix to be used in the name of the contact person, ex: Frenkie de Jong.
- * last name: Last name of the contact person.
- * emails: List of valid emails separated by comma.
- phone number: Phone number of the contact person if any. The country code should be provided as well, ex: +31xxxx for a Dutch phone number.
- mobile number: Mobile number of the contact person if any. The country code should be provided as well, ex: +31xxxx for a Dutch mobile number.
- fax number: Fax number of the contact person if any. The country code should be provided as well, ex: +31xxxx for a Dutch fax number.
- * type: The type of contact. Available types are: "technical", "administrative" and "contract".
The technical contact is mandatory, and is meant for technical support, therefore not possible to be deleted
The administrative contact is meant for administrative concerns.
The contract contact is the person of contact for contract issues.
Only one contact per type is supported.
The prefix * in the items listed above means they are mandatory.
Available features
- List all contacts of an account
- Add contacts to account
- Update details of contact
- Delete contact
Examples
List all contacts of an account
sequenceDiagram
Actor->>Administration API: GET accounts owned by supplier
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation"
Administration API-->>Actor: Use the account id of an specific account
Actor->>Administration API: GET contacts that belong to the account selected before
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/overviewUsingGET_2" "Swagger documentation"
Administration API-->>Actor: OK!
Add contacts to account
sequenceDiagram
Actor->>Administration API: GET accounts owned by supplier
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation"
Administration API-->>Actor: Use the account id of an specific account
Actor->>Administration API: Add contact to the account selected before
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/createUsingPOST_1" "Swagger documentation"
Administration API-->>Actor: CREATED!
Update details of contact
sequenceDiagram
Actor->>Administration API: GET contacts that belong to an account
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/overviewUsingGET_2" "Swagger documentation"
Administration API-->>Actor: Use the contact id of an specific contact!
Actor->>Administration API: Update details of the contact selected before
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/updateUsingPUT_2" "Swagger documentation"
Administration API-->>Actor: OK!
Delete contact
sequenceDiagram
Actor->>Administration API: GET contacts that belong to an account
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/overviewUsingGET_2" "Swagger documentation"
Administration API-->>Actor: Use the contact id of an specific contact!
Actor->>Administration API: Delete the contact selected before
Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/contact/deleteUsingDELETE" "Swagger documentation"
Administration API-->>Actor: OK!