Framework | Contact

Service to manage entities of type 'Contact'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/contacts

URL	api/{tenantKey}/{orgKey}/corePatterns/contacts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Contacts
PUT:
DELETE:
- DELETE Contact by identifier
- DELETE Contact by key

All Resources

This service uses the following resources:

ApiContactResource
ContactResource

All Enumerations

This service uses the following enumerations:

MaritalStatus
Salutation

GET Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/odata

GET /corePatterns/contacts/odata

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{id}

GET /corePatterns/contacts/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}

GET /corePatterns/contacts/{fileNumber}

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{id}/picture

GET /corePatterns/contacts/{id}/picture

POST Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts

POST /corePatterns/contacts

PUT Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/address

PUT /corePatterns/contacts/{fileNumber}/address

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/birthDate

PUT /corePatterns/contacts/{fileNumber}/birthDate

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/buildingNumber

PUT /corePatterns/contacts/{fileNumber}/buildingNumber

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/businessTelephone

PUT /corePatterns/contacts/{fileNumber}/businessTelephone

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/cityName

PUT /corePatterns/contacts/{fileNumber}/cityName

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/contactType

PUT /corePatterns/contacts/{fileNumber}/contactType

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/country

PUT /corePatterns/contacts/{fileNumber}/country

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/culture

PUT /corePatterns/contacts/{fileNumber}/culture

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/electronicMail

PUT /corePatterns/contacts/{fileNumber}/electronicMail

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/facebook

PUT /corePatterns/contacts/{fileNumber}/facebook

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/fileNumber

PUT /corePatterns/contacts/{fileNumber}/fileNumber

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/firstName

PUT /corePatterns/contacts/{fileNumber}/firstName

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/greeting

PUT /corePatterns/contacts/{fileNumber}/greeting

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/homeTelephone

PUT /corePatterns/contacts/{fileNumber}/homeTelephone

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/isActive

PUT /corePatterns/contacts/{fileNumber}/isActive

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/jobTitle

PUT /corePatterns/contacts/{fileNumber}/jobTitle

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/lastName

PUT /corePatterns/contacts/{fileNumber}/lastName

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/linkedIn

PUT /corePatterns/contacts/{fileNumber}/linkedIn

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/maritalStatus

PUT /corePatterns/contacts/{fileNumber}/maritalStatus

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/middleName

PUT /corePatterns/contacts/{fileNumber}/middleName

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/mobile

PUT /corePatterns/contacts/{fileNumber}/mobile

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/name

PUT /corePatterns/contacts/{fileNumber}/name

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/notes

PUT /corePatterns/contacts/{fileNumber}/notes

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/partyId

PUT /corePatterns/contacts/{fileNumber}/partyId

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/picture

PUT /corePatterns/contacts/{fileNumber}/picture

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/postalZone

PUT /corePatterns/contacts/{fileNumber}/postalZone

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/salutation

PUT /corePatterns/contacts/{fileNumber}/salutation

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/streetName

PUT /corePatterns/contacts/{fileNumber}/streetName

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/title

PUT /corePatterns/contacts/{fileNumber}/title

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}/websiteUrl

PUT /corePatterns/contacts/{fileNumber}/websiteUrl

DELETE Operations

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{id}

DELETE /corePatterns/contacts/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/contacts/{fileNumber}

DELETE /corePatterns/contacts/{fileNumber}

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.
facebook	(string) The contact’s facebook page.
linkedIn	(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.
facebook	(string) The contact’s facebook page.
linkedIn	(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.

Enumerations

MaritalStatus

1	Single
2	Married

Salutation

1	Mr
2	Ms
3	DearSir
4	DearMadam