GET contactperson/{id}

Get an array of contact persons for a client.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the client.

integer

Required

Body Parameters

None.

Response Information

Resource Description

ClientDetailsContactPersonViewModel[], containing information about the client's contact persons.

Collection of FiscaalGemak.Core.Models.ViewModels.ClientDetailsContactPersonViewModel
NameDescriptionTypeAdditional information
AuthenticationType

FiscaalGemak.Core.Models.Enums.AuthenticationType

Required

ClientId

integer

None.

CompanyRole

string

Max length: 128

EmailAddress

string

String length: inclusive between 0 and 128

FirstName

string

String length: inclusive between 0 and 80

FooterText

string

None.

FullName

string

None.

HasCommunicationApprovalAccess

boolean

None.

HasCommunicationViewAccess

boolean

None.

Id

integer

None.

Initials

string

String length: inclusive between 0 and 50

Prefix

string

String length: inclusive between 0 and 50

Salutation

FiscaalGemak.Core.Models.Enums.Salutation

None.

SalutationCustom

string

String length: inclusive between 0 and 50

Surname

string

String length: inclusive between 0 and 128

TelephoneNumber

string

Matching regular expression pattern: ^(\+)?[0-9 \-]{0,15}

String length: inclusive between 10 and 14

DeclarationTypes

Collection of FiscaalGemak.Core.Models.Models.DeclarationType

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AuthenticationType": 0,
    "ClientId": 1,
    "CompanyRole": "sample string 1",
    "EmailAddress": "sample string 2",
    "FirstName": "sample string 3",
    "FooterText": "sample string 4",
    "FullName": "sample string 8 sample string 9 sample string 11",
    "HasCommunicationApprovalAccess": true,
    "HasCommunicationViewAccess": true,
    "Id": 7,
    "Initials": "sample string 8",
    "Prefix": "sample string 9",
    "Salutation": 0,
    "SalutationCustom": "sample string 10",
    "Surname": "sample string 11",
    "TelephoneNumber": "sample string 12",
    "DeclarationTypes": [
      0,
      0
    ]
  },
  {
    "AuthenticationType": 0,
    "ClientId": 1,
    "CompanyRole": "sample string 1",
    "EmailAddress": "sample string 2",
    "FirstName": "sample string 3",
    "FooterText": "sample string 4",
    "FullName": "sample string 8 sample string 9 sample string 11",
    "HasCommunicationApprovalAccess": true,
    "HasCommunicationViewAccess": true,
    "Id": 7,
    "Initials": "sample string 8",
    "Prefix": "sample string 9",
    "Salutation": 0,
    "SalutationCustom": "sample string 10",
    "Surname": "sample string 11",
    "TelephoneNumber": "sample string 12",
    "DeclarationTypes": [
      0,
      0
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientDetailsContactPersonViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FiscaalGemak.Core.Models.ViewModels">
  <ClientDetailsContactPersonViewModel>
    <AuthenticationType>Google</AuthenticationType>
    <ClientId>1</ClientId>
    <CompanyRole>sample string 1</CompanyRole>
    <DeclarationTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/FiscaalGemak.Core.Models.Models">
      <d3p1:DeclarationType>None</d3p1:DeclarationType>
      <d3p1:DeclarationType>None</d3p1:DeclarationType>
    </DeclarationTypes>
    <EmailAddress>sample string 2</EmailAddress>
    <FirstName>sample string 3</FirstName>
    <FooterText>sample string 4</FooterText>
    <HasCommunicationApprovalAccess>true</HasCommunicationApprovalAccess>
    <HasCommunicationViewAccess>true</HasCommunicationViewAccess>
    <Id>7</Id>
    <Initials>sample string 8</Initials>
    <Prefix>sample string 9</Prefix>
    <Salutation>Custom</Salutation>
    <SalutationCustom>sample string 10</SalutationCustom>
    <Surname>sample string 11</Surname>
    <TelephoneNumber>sample string 12</TelephoneNumber>
  </ClientDetailsContactPersonViewModel>
  <ClientDetailsContactPersonViewModel>
    <AuthenticationType>Google</AuthenticationType>
    <ClientId>1</ClientId>
    <CompanyRole>sample string 1</CompanyRole>
    <DeclarationTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/FiscaalGemak.Core.Models.Models">
      <d3p1:DeclarationType>None</d3p1:DeclarationType>
      <d3p1:DeclarationType>None</d3p1:DeclarationType>
    </DeclarationTypes>
    <EmailAddress>sample string 2</EmailAddress>
    <FirstName>sample string 3</FirstName>
    <FooterText>sample string 4</FooterText>
    <HasCommunicationApprovalAccess>true</HasCommunicationApprovalAccess>
    <HasCommunicationViewAccess>true</HasCommunicationViewAccess>
    <Id>7</Id>
    <Initials>sample string 8</Initials>
    <Prefix>sample string 9</Prefix>
    <Salutation>Custom</Salutation>
    <SalutationCustom>sample string 10</SalutationCustom>
    <Surname>sample string 11</Surname>
    <TelephoneNumber>sample string 12</TelephoneNumber>
  </ClientDetailsContactPersonViewModel>
</ArrayOfClientDetailsContactPersonViewModel>