GET api/ClientContact?contactId={contactId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientContactMainViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientContacts | Collection of ClientContactDto |
None. |
|
| CurrentClientContact | ClientContactDto |
None. |
|
| ClientName | string |
None. |
|
| CurrentContactListIndex | integer |
None. |
|
| DisableAllFields | boolean |
None. |
|
| HasDeleteClientsClearance | boolean |
None. |
|
| IsCtrlPress | boolean |
None. |
|
| Notification | NotificationDto |
None. |
|
| NotificationResponse | NotificationResponseDto |
None. |
|
| ExportViewModel | ExportViewModel |
None. |
|
| ImportViewModel | ImportViewModel |
None. |
|
| ImportResultViewModel | ImportResultViewModel |
None. |
|
| FileName | string |
None. |
|
| Path | string |
None. |
|
| DeleteAll | boolean |
None. |
|
| IsHeader | boolean |
None. |
|
| ProceedSuccess | boolean |
None. |
|
| DisablePasteToJob | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"clientContacts": [
{
"id": "fff60133-cf90-4e55-97ca-e3215d877402",
"clientId": "f98f9b9e-c773-4e65-ba9a-bf556397e9f7",
"clientName": "sample string 1",
"contactName": "sample string 2",
"salutation": "sample string 3",
"role": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"mobile": "sample string 7",
"tag": "sample string 8",
"electronicMail": "sample string 9",
"contactNote": "sample string 10",
"statusId": 1,
"userField": "sample string 11"
},
{
"id": "fff60133-cf90-4e55-97ca-e3215d877402",
"clientId": "f98f9b9e-c773-4e65-ba9a-bf556397e9f7",
"clientName": "sample string 1",
"contactName": "sample string 2",
"salutation": "sample string 3",
"role": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"mobile": "sample string 7",
"tag": "sample string 8",
"electronicMail": "sample string 9",
"contactNote": "sample string 10",
"statusId": 1,
"userField": "sample string 11"
}
],
"currentClientContact": {
"id": "fff60133-cf90-4e55-97ca-e3215d877402",
"clientId": "f98f9b9e-c773-4e65-ba9a-bf556397e9f7",
"clientName": "sample string 1",
"contactName": "sample string 2",
"salutation": "sample string 3",
"role": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"mobile": "sample string 7",
"tag": "sample string 8",
"electronicMail": "sample string 9",
"contactNote": "sample string 10",
"statusId": 1,
"userField": "sample string 11"
},
"clientName": "sample string 1",
"currentContactListIndex": 2,
"disableAllFields": true,
"hasDeleteClientsClearance": true,
"isCtrlPress": true,
"notification": {
"title": "sample string 1",
"description": "sample string 2",
"type": 0,
"identifier": "sample string 3"
},
"notificationResponse": {
"responseType": 0,
"value": "sample string 1",
"identifier": "sample string 2"
},
"exportViewModel": {
"success": true,
"message": "sample string 2",
"path": "sample string 3",
"fileName": "sample string 4",
"fileData": null,
"fileContent": "sample string 5",
"sequenceFileContent": "sample string 6",
"sequenceFilePath": "sample string 7",
"sequenceFileName": "sample string 8",
"postProcessCL": "sample string 9",
"postProcessCLPath": "sample string 10",
"postProcessArgument": "sample string 11",
"oneSavePrompt": true,
"dockSawFiles": [
{
"fileContent": "sample string 1",
"filePath": "sample string 2",
"fileName": "sample string 3",
"fileExtension": "sample string 4"
},
{
"fileContent": "sample string 1",
"filePath": "sample string 2",
"fileName": "sample string 3",
"fileExtension": "sample string 4"
}
],
"exportFilesPerPc": [
{
"fileContent": "sample string 1",
"filePath": "sample string 2",
"fileName": "sample string 3",
"fileExtension": "sample string 4"
},
{
"fileContent": "sample string 1",
"filePath": "sample string 2",
"fileName": "sample string 3",
"fileExtension": "sample string 4"
}
],
"pageContentList": [
{
"id": 1,
"reportContent": "sample string 2",
"pageNumber": 3,
"reportName": "sample string 4",
"pageFormat": "sample string 5",
"pageOrientation": 6,
"copies": 7
},
{
"id": 1,
"reportContent": "sample string 2",
"pageNumber": 3,
"reportName": "sample string 4",
"pageFormat": "sample string 5",
"pageOrientation": 6,
"copies": 7
}
],
"exportType": 13
},
"importViewModel": {
"fileName": "sample string 1",
"path": "sample string 2"
},
"importResultViewModel": {
"success": true,
"message": "sample string 2"
},
"fileName": "sample string 6",
"path": "sample string 7",
"deleteAll": true,
"isHeader": true,
"proceedSuccess": true,
"disablePasteToJob": true
}
application/xml, text/xml
Sample:
<ClientContactMainViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<ClientContacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:ClientContactDto>
<d2p1:ClientId>f98f9b9e-c773-4e65-ba9a-bf556397e9f7</d2p1:ClientId>
<d2p1:ClientName>sample string 1</d2p1:ClientName>
<d2p1:ContactName>sample string 2</d2p1:ContactName>
<d2p1:ContactNote>sample string 10</d2p1:ContactNote>
<d2p1:ElectronicMail>sample string 9</d2p1:ElectronicMail>
<d2p1:Fax>sample string 6</d2p1:Fax>
<d2p1:Id>fff60133-cf90-4e55-97ca-e3215d877402</d2p1:Id>
<d2p1:Mobile>sample string 7</d2p1:Mobile>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:Role>sample string 4</d2p1:Role>
<d2p1:Salutation>sample string 3</d2p1:Salutation>
<d2p1:StatusId>1</d2p1:StatusId>
<d2p1:Tag>sample string 8</d2p1:Tag>
<d2p1:UserField>sample string 11</d2p1:UserField>
</d2p1:ClientContactDto>
<d2p1:ClientContactDto>
<d2p1:ClientId>f98f9b9e-c773-4e65-ba9a-bf556397e9f7</d2p1:ClientId>
<d2p1:ClientName>sample string 1</d2p1:ClientName>
<d2p1:ContactName>sample string 2</d2p1:ContactName>
<d2p1:ContactNote>sample string 10</d2p1:ContactNote>
<d2p1:ElectronicMail>sample string 9</d2p1:ElectronicMail>
<d2p1:Fax>sample string 6</d2p1:Fax>
<d2p1:Id>fff60133-cf90-4e55-97ca-e3215d877402</d2p1:Id>
<d2p1:Mobile>sample string 7</d2p1:Mobile>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:Role>sample string 4</d2p1:Role>
<d2p1:Salutation>sample string 3</d2p1:Salutation>
<d2p1:StatusId>1</d2p1:StatusId>
<d2p1:Tag>sample string 8</d2p1:Tag>
<d2p1:UserField>sample string 11</d2p1:UserField>
</d2p1:ClientContactDto>
</ClientContacts>
<ClientName>sample string 1</ClientName>
<CurrentClientContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:ClientId>f98f9b9e-c773-4e65-ba9a-bf556397e9f7</d2p1:ClientId>
<d2p1:ClientName>sample string 1</d2p1:ClientName>
<d2p1:ContactName>sample string 2</d2p1:ContactName>
<d2p1:ContactNote>sample string 10</d2p1:ContactNote>
<d2p1:ElectronicMail>sample string 9</d2p1:ElectronicMail>
<d2p1:Fax>sample string 6</d2p1:Fax>
<d2p1:Id>fff60133-cf90-4e55-97ca-e3215d877402</d2p1:Id>
<d2p1:Mobile>sample string 7</d2p1:Mobile>
<d2p1:Phone>sample string 5</d2p1:Phone>
<d2p1:Role>sample string 4</d2p1:Role>
<d2p1:Salutation>sample string 3</d2p1:Salutation>
<d2p1:StatusId>1</d2p1:StatusId>
<d2p1:Tag>sample string 8</d2p1:Tag>
<d2p1:UserField>sample string 11</d2p1:UserField>
</CurrentClientContact>
<CurrentContactListIndex>2</CurrentContactListIndex>
<DeleteAll>true</DeleteAll>
<DisableAllFields>true</DisableAllFields>
<DisablePasteToJob>true</DisablePasteToJob>
<ExportViewModel>
<DockSawFiles>
<ExportFileViewModel>
<FileContent>sample string 1</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileName>sample string 3</FileName>
<FilePath>sample string 2</FilePath>
</ExportFileViewModel>
<ExportFileViewModel>
<FileContent>sample string 1</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileName>sample string 3</FileName>
<FilePath>sample string 2</FilePath>
</ExportFileViewModel>
</DockSawFiles>
<ExportFilesPerPc>
<ExportFileViewModel>
<FileContent>sample string 1</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileName>sample string 3</FileName>
<FilePath>sample string 2</FilePath>
</ExportFileViewModel>
<ExportFileViewModel>
<FileContent>sample string 1</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileName>sample string 3</FileName>
<FilePath>sample string 2</FilePath>
</ExportFileViewModel>
</ExportFilesPerPc>
<ExportType>13</ExportType>
<FileContent>sample string 5</FileContent>
<FileData xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
<FileName>sample string 4</FileName>
<Message>sample string 2</Message>
<OneSavePrompt>true</OneSavePrompt>
<PageContentList>
<PageContentViewModel>
<Copies>7</Copies>
<Id>1</Id>
<PageFormat>sample string 5</PageFormat>
<PageNumber>3</PageNumber>
<PageOrientation>6</PageOrientation>
<ReportContent>sample string 2</ReportContent>
<ReportName>sample string 4</ReportName>
</PageContentViewModel>
<PageContentViewModel>
<Copies>7</Copies>
<Id>1</Id>
<PageFormat>sample string 5</PageFormat>
<PageNumber>3</PageNumber>
<PageOrientation>6</PageOrientation>
<ReportContent>sample string 2</ReportContent>
<ReportName>sample string 4</ReportName>
</PageContentViewModel>
</PageContentList>
<Path>sample string 3</Path>
<PostProcessArgument>sample string 11</PostProcessArgument>
<PostProcessCL>sample string 9</PostProcessCL>
<PostProcessCLPath>sample string 10</PostProcessCLPath>
<SequenceFileContent>sample string 6</SequenceFileContent>
<SequenceFileName>sample string 8</SequenceFileName>
<SequenceFilePath>sample string 7</SequenceFilePath>
<Success>true</Success>
</ExportViewModel>
<FileName>sample string 6</FileName>
<HasDeleteClientsClearance>true</HasDeleteClientsClearance>
<ImportResultViewModel>
<Message>sample string 2</Message>
<Success>true</Success>
</ImportResultViewModel>
<ImportViewModel>
<FileName>sample string 1</FileName>
<Path>sample string 2</Path>
</ImportViewModel>
<IsCtrlPress>true</IsCtrlPress>
<IsHeader>true</IsHeader>
<Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Common">
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 2</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_Identifier_x003E_k__BackingField>sample string 3</d2p1:_x003C_Identifier_x003E_k__BackingField>
<d2p1:_x003C_Title_x003E_k__BackingField>sample string 1</d2p1:_x003C_Title_x003E_k__BackingField>
<d2p1:_x003C_Type_x003E_k__BackingField>Default</d2p1:_x003C_Type_x003E_k__BackingField>
</Notification>
<NotificationResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
<d2p1:Identifier>sample string 2</d2p1:Identifier>
<d2p1:ResponseType>Null</d2p1:ResponseType>
<d2p1:Value>sample string 1</d2p1:Value>
</NotificationResponse>
<Path>sample string 7</Path>
<ProceedSuccess>true</ProceedSuccess>
</ClientContactMainViewModel>