POST api/ApiIntegration/SBApiAddClientContact

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
ClientKey	globally unique identifier	None.
ContactKey	globally unique identifier	None.
ContactName	string	None.
Salutation	string	None.
Role	string	None.
Phone	string	None.
Fax	string	None.
Mobile	string	None.
Email	string	None.
ContactNote	string	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "clientKey": "58a688ba-8033-4893-9898-e65f99dbf37d",
  "contactKey": "9b5e50af-c3be-4726-9db1-00ebc7c30671",
  "contactName": "sample string 3",
  "salutation": "sample string 4",
  "role": "sample string 5",
  "phone": "sample string 6",
  "fax": "sample string 7",
  "mobile": "sample string 8",
  "email": "sample string 9",
  "contactNote": "sample string 10"
}

application/xml, text/xml

Sample:

<ApiAddClientContactParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ClientKey>58a688ba-8033-4893-9898-e65f99dbf37d</ClientKey>
  <ContactKey>9b5e50af-c3be-4726-9db1-00ebc7c30671</ContactKey>
  <ContactName>sample string 3</ContactName>
  <ContactNote>sample string 10</ContactNote>
  <Email>sample string 9</Email>
  <Fax>sample string 7</Fax>
  <Mobile>sample string 8</Mobile>
  <Phone>sample string 6</Phone>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Role>sample string 5</Role>
  <Salutation>sample string 4</Salutation>
</ApiAddClientContactParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientWithContactsResponse

Name	Description	Type	Additional information
ApiResponse		ApiResponse	None.
ClientInfo		ApiClientWithContacts	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "55d2530e-143c-457a-92fa-090052b0f098",
    "responseNote": "sample string 2"
  },
  "clientInfo": {
    "clientKey": "9a2c62ad-a396-477f-86b3-923168d2c93b",
    "clientName": "sample string 2",
    "clientNote": "sample string 3",
    "contactName": "sample string 4",
    "salutation": "sample string 5",
    "noAndStreet": "sample string 6",
    "suburb": "sample string 7",
    "city": "sample string 8",
    "phone": "sample string 9",
    "mobile": "sample string 10",
    "email": "sample string 11",
    "contacts": [
      {
        "contactUid": "1ade96b1-cc63-43bb-95dc-572aeef3af25",
        "contactName": "sample string 2",
        "salutation": "sample string 3",
        "role": "sample string 4",
        "phone": "sample string 5",
        "fax": "sample string 6",
        "mobile": "sample string 7",
        "email": "sample string 8",
        "contactNote": "sample string 9"
      },
      {
        "contactUid": "1ade96b1-cc63-43bb-95dc-572aeef3af25",
        "contactName": "sample string 2",
        "salutation": "sample string 3",
        "role": "sample string 4",
        "phone": "sample string 5",
        "fax": "sample string 6",
        "mobile": "sample string 7",
        "email": "sample string 8",
        "contactNote": "sample string 9"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ApiClientWithContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>55d2530e-143c-457a-92fa-090052b0f098</ReturnKey>
  </ApiResponse>
  <ClientInfo>
    <City>sample string 8</City>
    <ClientKey>9a2c62ad-a396-477f-86b3-923168d2c93b</ClientKey>
    <ClientName>sample string 2</ClientName>
    <ClientNote>sample string 3</ClientNote>
    <ContactName>sample string 4</ContactName>
    <Contacts>
      <ApiContactInfo>
        <ContactName>sample string 2</ContactName>
        <ContactNote>sample string 9</ContactNote>
        <ContactUid>1ade96b1-cc63-43bb-95dc-572aeef3af25</ContactUid>
        <Email>sample string 8</Email>
        <Fax>sample string 6</Fax>
        <Mobile>sample string 7</Mobile>
        <Phone>sample string 5</Phone>
        <Role>sample string 4</Role>
        <Salutation>sample string 3</Salutation>
      </ApiContactInfo>
      <ApiContactInfo>
        <ContactName>sample string 2</ContactName>
        <ContactNote>sample string 9</ContactNote>
        <ContactUid>1ade96b1-cc63-43bb-95dc-572aeef3af25</ContactUid>
        <Email>sample string 8</Email>
        <Fax>sample string 6</Fax>
        <Mobile>sample string 7</Mobile>
        <Phone>sample string 5</Phone>
        <Role>sample string 4</Role>
        <Salutation>sample string 3</Salutation>
      </ApiContactInfo>
    </Contacts>
    <Email>sample string 11</Email>
    <Mobile>sample string 10</Mobile>
    <NoAndStreet>sample string 6</NoAndStreet>
    <Phone>sample string 9</Phone>
    <Salutation>sample string 5</Salutation>
    <Suburb>sample string 7</Suburb>
  </ClientInfo>
</ApiClientWithContactsResponse>