ApexERPHost

<back to all web services

GetCompanyPersons

Requires Authentication
The following routes are available for this service:
GET/Crm/Company/{CompanyId}/Persons
GET/Crm/Company/Persons
GetCompanyPersons Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathint?No
IsCustomerquerybool?No
IsSupplierquerybool?No
IsOwnquerybool?No
IsPartnerquerybool?No
GetCompanyPersonsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<CrmPersons>No
CrmPersons Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PersonSNformstringNo
PNameformstringNo
FirstNameformstringNo
LastNameformstringNo
SecondNameformstringNo
DateBornformDateTime?No
PhoneformstringNo
MobileformstringNo
WorkPhoneformstringNo
EmailformstringNo
CityIdformstringNo
DescriptionformstringNo
NoteformstringNo
Citizenshipformint?No
Is_RezidentformboolNo
Sexformint?No
SpendformboolNo
UnidformGuidNo
PhonesformList<pPhone>No
EMailsformList<pEmail>No
WebPagesformList<pWebPage>No
PositionformstringNo
pPhone Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
PhoneTypeformintNo
PhoneformstringNo
PriorityformboolNo
NoteformstringNo
pEmail Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
EmailTypeformintNo
EmailformstringNo
NoteformstringNo
pWebPage Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
WebPageTypeformintNo
WebPageformstringNo
NoteformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Crm/Company/{CompanyId}/Persons HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCompanyPersonsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <CrmPersons>
      <Id>0</Id>
      <PersonSN>String</PersonSN>
      <PName>String</PName>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <SecondName>String</SecondName>
      <DateBorn>0001-01-01T00:00:00</DateBorn>
      <Phone>String</Phone>
      <Mobile>String</Mobile>
      <WorkPhone>String</WorkPhone>
      <Email>String</Email>
      <CityId>String</CityId>
      <Description>String</Description>
      <Note>String</Note>
      <Citizenship>0</Citizenship>
      <Is_Rezident>false</Is_Rezident>
      <Sex>0</Sex>
      <Spend>false</Spend>
      <Unid>00000000-0000-0000-0000-000000000000</Unid>
      <Phones>
        <pPhone>
          <Id>0</Id>
          <Unid>00000000-0000-0000-0000-000000000000</Unid>
          <PhoneType>0</PhoneType>
          <Phone>String</Phone>
          <Priority>false</Priority>
          <Note>String</Note>
        </pPhone>
      </Phones>
      <EMails>
        <pEmail>
          <Id>0</Id>
          <Unid>00000000-0000-0000-0000-000000000000</Unid>
          <EmailType>0</EmailType>
          <Email>String</Email>
          <Note>String</Note>
        </pEmail>
      </EMails>
      <WebPages>
        <pWebPage>
          <Id>0</Id>
          <Unid>00000000-0000-0000-0000-000000000000</Unid>
          <WebPageType>0</WebPageType>
          <WebPage>String</WebPage>
          <Note>String</Note>
        </pWebPage>
      </WebPages>
      <Position>String</Position>
    </CrmPersons>
  </Result>
</GetCompanyPersonsResponse>