GET api/Contacts/{contactID}

Get contact by contactID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

globally unique identifier

Required

Body Parameters

None.

Remarks

404 Not found is returned if the specified article cannot be found.

Example

None.

Response Information

Resource Description

ContactResponse
NameDescriptionTypeAdditional information
ContactId

globally unique identifier

Required
BranchId

integer

None.
BranchName

string

Max length: 160
Name

string

Required

Max length: 128
Address1

string

Max length: 100
Address2

string

Max length: 100
Address3

string

Max length: 100
PostalCode

string

Max length: 10
Town

string

Max length: 50
CountryId

string

Required

Max length: 2
CountryName

string

Max length: 100
Email

string

Max length: 50
Phone

string

Max length: 50
Mobile

string

Max length: 50
BusinessPosition

string

Max length: 50
Note

string

None.
PreferredCultureId

string

Max length: 5
Identification

integer

None.
IsDefault

boolean

Required
UseCustomerAddress

boolean

Required
CustomerNo

integer

None.
CreatedDate

Date when the contact was created.

 date

Required
CreatedBy

Contact created by user.

 string

Required
ChangedDate

Date when the contact was last changed.

 date

Required
ChangedBy

Last changed by user.

 string

Required
GDPRConsentDate

Gets the date when the contact has given consent for data storing and processing.

 date

None.
MarkedForRemoval

Gets the date of removal. If this date is set the contact has been asked to be removed.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ContactId": "eecdf17d-220f-46cc-9293-c111c34c20df",
  "BranchId": 1,
  "BranchName": "sample string 2",
  "Name": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "PostalCode": "sample string 7",
  "Town": "sample string 8",
  "CountryId": "sample string 9",
  "CountryName": "sample string 10",
  "Email": "sample string 11",
  "Phone": "sample string 12",
  "Mobile": "sample string 13",
  "BusinessPosition": "sample string 14",
  "Note": "sample string 15",
  "PreferredCultureId": "sample string 16",
  "Identification": 1,
  "IsDefault": true,
  "UseCustomerAddress": true,
  "CustomerNo": 1,
  "CreatedDate": "12/21/2025 1:02:44 PM",
  "CreatedBy": "sample string 20",
  "ChangedDate": "12/21/2025 1:02:44 PM",
  "ChangedBy": "sample string 22",
  "GDPRConsentDate": "12/21/2025 1:02:44 PM",
  "MarkedForRemoval": "12/21/2025 1:02:44 PM"
}

application/xml, text/xml

Sample: 
<ContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Address3>sample string 6</Address3>
  <BranchId>1</BranchId>
  <BranchName>sample string 2</BranchName>
  <BusinessPosition>sample string 14</BusinessPosition>
  <ChangedBy>sample string 22</ChangedBy>
  <ChangedDate>2025-12-21T13:02:44.49914+00:00</ChangedDate>
  <ContactId>eecdf17d-220f-46cc-9293-c111c34c20df</ContactId>
  <CountryId>sample string 9</CountryId>
  <CountryName>sample string 10</CountryName>
  <CreatedBy>sample string 20</CreatedBy>
  <CreatedDate>2025-12-21T13:02:44.49914+00:00</CreatedDate>
  <CustomerNo>1</CustomerNo>
  <Email>sample string 11</Email>
  <GDPRConsentDate>2025-12-21T13:02:44.49914+00:00</GDPRConsentDate>
  <Identification>1</Identification>
  <IsDefault>true</IsDefault>
  <MarkedForRemoval>2025-12-21T13:02:44.49914+00:00</MarkedForRemoval>
  <Mobile>sample string 13</Mobile>
  <Name>sample string 3</Name>
  <Note>sample string 15</Note>
  <Phone>sample string 12</Phone>
  <PostalCode>sample string 7</PostalCode>
  <PreferredCultureId>sample string 16</PreferredCultureId>
  <Town>sample string 8</Town>
  <UseCustomerAddress>true</UseCustomerAddress>
</ContactResponse>