Platform | Contact
Service to manage entities of type 'Contact'.
Overview
URL | api/{tenantKey}/{orgKey}/corePatterns/contacts |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive Contact
- PUT Set FileNumber Contact
- PUT Set Greeting Contact
- PUT Set JobTitle Contact
- PUT Set Title Contact
- PUT Set Name Contact
- PUT Set FirstName Contact
- PUT Set MiddleName Contact
- PUT Set LastName Contact
- PUT Set ElectronicMail Contact
- PUT Set WebsiteUrl Contact
- PUT Set BusinessTelephone Contact
- PUT Set HomeTelephone Contact
- PUT Set Mobile Contact
- PUT Set Facebook Contact
- PUT Set LinkedIn Contact
- PUT Set Notes Contact
- PUT Set Picture Contact
- PUT Set BirthDate Contact
- PUT Set StreetName Contact
- PUT Set BuildingNumber Contact
- PUT Set CityName Contact
- PUT Set PostalZone Contact
- PUT Set Country Contact
- PUT Set Address Contact
- PUT Set MaritalStatus Contact
- PUT Set ContactType Contact
- PUT Set PartyId Contact
- PUT Set Salutation Contact
- PUT Set Culture Contact
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Contacts (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See ContactResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Contact by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See ContactResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Contact by key
Returns the entity record that matches the specified key.
The following elements are required:
fileNumber | (int) The contact's file number. |
Response:
When successful, the response body contains the entity record. See ContactResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Contact Picture.
Returns the value of attribute 'Picture' of the specified entity record.
The following elements are required:
id | (string) The record identifier. |
fileName | (string) The file name. |
Response:
When successful, the response is a stream with the image file. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Contacts
Creates a new entity record.
The following elements are required:
contactResource | (ApiContactResource) The request body should contain the entity record that should be created. See ApiContactResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiContactResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Address Contact
Updates the value of attribute 'Address' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BirthDate Contact
Updates the value of attribute 'BirthDate' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (DateTime) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BuildingNumber Contact
Updates the value of attribute 'BuildingNumber' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BusinessTelephone Contact
Updates the value of attribute 'BusinessTelephone' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CityName Contact
Updates the value of attribute 'CityName' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ContactType Contact
Updates the value of attribute 'ContactType' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Country Contact
Updates the value of attribute 'Country' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Culture Contact
Updates the value of attribute 'Culture' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ElectronicMail Contact
Updates the value of attribute 'ElectronicMail' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Facebook Contact
Updates the value of attribute 'Facebook' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FileNumber Contact
Updates the value of attribute 'FileNumber' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FirstName Contact
Updates the value of attribute 'FirstName' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Greeting Contact
Updates the value of attribute 'Greeting' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set HomeTelephone Contact
Updates the value of attribute 'HomeTelephone' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Contact
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set JobTitle Contact
Updates the value of attribute 'JobTitle' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LastName Contact
Updates the value of attribute 'LastName' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LinkedIn Contact
Updates the value of attribute 'LinkedIn' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MaritalStatus Contact
Updates the value of attribute 'MaritalStatus' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (enum MaritalStatus) The request body should contain the new value for the attribute. See MaritalStatus. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MiddleName Contact
Updates the value of attribute 'MiddleName' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Mobile Contact
Updates the value of attribute 'Mobile' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Name Contact
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Notes Contact
Updates the value of attribute 'Notes' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PartyId Contact
Updates the value of attribute 'PartyId' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (Guid) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Picture Contact
Updates the value of attribute 'Picture' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PostalZone Contact
Updates the value of attribute 'PostalZone' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Salutation Contact
Updates the value of attribute 'Salutation' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (enum Salutation) The request body should contain the new value for the attribute. See Salutation. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set StreetName Contact
Updates the value of attribute 'StreetName' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Title Contact
Updates the value of attribute 'Title' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set WebsiteUrl Contact
Updates the value of attribute 'WebsiteUrl' in the specified entity record.
The following elements are required:
fileNumber | (int) The contact's file number. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Contact by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Contact by key
Deletes the entity record that matches the specified key.
The following elements are required:
fileNumber | (int) The contact's file number. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiContactResource
The following elements are required:
fileNumber | (int) The contact's file number. |
name | (string) The contact’s name. |
contactType | (string) The contact's type. |
culture | (string) Culture. |
The following elements are optional:
greeting | (string) The contact's greeting. |
jobTitle | (string) The contact's job title. |
title | (string) Mr., Mrs., Miss... |
firstName | (string) The contact’s first name. |
middleName | (string) The contact’s middle name. |
lastName | (string) The contact’s last name. |
electronicMail | (string) The contact’s electronic mail. |
websiteUrl | (string) The contact’s website page. |
businessTelephone | (string) The contact’s business telephone. |
homeTelephone | (string) The contact’s home telephone. |
mobile | (string) The contact’s mobile. |
(string) The contact’s facebook page. | |
(string) The contact’s linkedIn page. | |
notes | (string) The contact’s notes. |
picture | (string) The contact’s picture. |
birthDate | (DateTime) The contact’s birth date. |
streetName | (string) The contact’s street name. |
buildingNumber | (string) The contact’s house number. |
cityName | (string) The contact’s city name. |
postalZone | (string) The contact’s postal code. |
country | (string) The contact’s country name. |
address | (string) The contact’s address. |
maritalStatus | (enum MaritalStatus) The contact’s marital status.
See MaritalStatus. |
partyId | (Guid) The party identifier. |
salutation | (enum Salutation) Greeting.
See Salutation. |
ContactResource
The following elements are required:
fileNumber | (int) The contact's file number. |
name | (string) The contact’s name. |
contactType | (string) The contact's type.
(fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service. |
culture | (string) Culture.
(fk) Allowed value: the natural key of a record of type Culture. These records are accessibly through the Cultures service. |
The following elements are optional:
greeting | (string) The contact's greeting. |
jobTitle | (string) The contact's job title. |
title | (string) Mr., Mrs., Miss... |
firstName | (string) The contact’s first name. |
middleName | (string) The contact’s middle name. |
lastName | (string) The contact’s last name. |
electronicMail | (string) The contact’s electronic mail. |
websiteUrl | (string) The contact’s website page. |
businessTelephone | (string) The contact’s business telephone. |
homeTelephone | (string) The contact’s home telephone. |
mobile | (string) The contact’s mobile. |
(string) The contact’s facebook page. | |
(string) The contact’s linkedIn page. | |
notes | (string) The contact’s notes. |
picture | (string) The contact’s picture. |
birthDate | (DateTime) The contact’s birth date. |
streetName | (string) The contact’s street name. |
buildingNumber | (string) The contact’s house number. |
cityName | (string) The contact’s city name. |
postalZone | (string) The contact’s postal code. |
country | (string) The contact’s country name.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
address | (string) The contact’s address.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service. |
maritalStatus | (enum MaritalStatus) The contact’s marital status.
See MaritalStatus. |
partyId | (Guid) The party identifier. |
belongsToParty | (bool) Belongs To Party. |
salutation | (enum Salutation) Greeting.
See Salutation. |