GET api/Contacts/{contactID}
Get contact by contactID
Request Information
URI Parameters
| Name | Description | Type | Additional 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| Name | Description | Type | Additional 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 |
|
| 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 |
Required |
|
| CreatedBy | string |
Required |
|
| ChangedDate | date |
Required |
|
| ChangedBy | string |
Required |
|
| GDPRConsentDate | date |
None. |
|
| MarkedForRemoval | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"ContactId": "d8eba5c2-d1c1-4e97-b910-a2a8a54a64bb",
"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": "2026-01-21 22:50:58",
"CreatedBy": "sample string 20",
"ChangedDate": "2026-01-21 22:50:58",
"ChangedBy": "sample string 22",
"GDPRConsentDate": "2026-01-21 22:50:58",
"MarkedForRemoval": "2026-01-21 22:50:58"
}
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>2026-01-21T22:50:58.8339511+01:00</ChangedDate> <ContactId>d8eba5c2-d1c1-4e97-b910-a2a8a54a64bb</ContactId> <CountryId>sample string 9</CountryId> <CountryName>sample string 10</CountryName> <CreatedBy>sample string 20</CreatedBy> <CreatedDate>2026-01-21T22:50:58.8339511+01:00</CreatedDate> <CustomerNo>1</CustomerNo> <Email>sample string 11</Email> <GDPRConsentDate>2026-01-21T22:50:58.8339511+01:00</GDPRConsentDate> <Identification>1</Identification> <IsDefault>true</IsDefault> <MarkedForRemoval>2026-01-21T22:50:58.8339511+01: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>