POST ContactAggregate

Insert a contact aggregate. Inserts the contact and inserts or updates the associated company and contact manager.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.

FileId Specifies the file id of the file to perform the operation upon. integer

Required

Body Parameters

Contact aggregate that includes the contact's company and contact manager.

ContactAggregate
Name Description Type Additional information
Id Contact's Id in Saasu system. integer

None.

LastUpdatedId Identifier used for concurrency checking. Required for update. string

None.

Salutation The salutation or title of the contact. Valid values: Mr., Mrs., Ms., Dr., Prof. string

None.

GivenName The first or given name of the contact. string

None.

MiddleInitials The middle initials of the contact. string

None.

FamilyName The last name or surname of the contact. string

None.

Company The Organisation or Company that employs the Contact. Company

None.

PositionTitle Contact's position or role. string

None.

PrimaryPhone Primary contact number for the contact. string

None.

MobilePhone The contact's mobile phone number. string

None.

HomePhone Home contact number for the contact. string

None.

Fax The contacts fax number. string

None.

EmailAddress The contact's email address. string

None.

ContactId Is used as an Account or Contact reference for this person if they are a supplier or customer. This is your reference or their reference depending on how you prefer to use this field. string

None.

ContactManager This is another Contact record in Saasu and is used to represent the Account Manager, Salesperson or similar for this Contact record. ContactManager

None.

IsPartner Indicates if the contact is a partner. boolean

None.

IsCustomer Indicates if the contact is a customer. boolean

None.

IsSupplier Indicates if the contact is a supplier. boolean

None.

IsContractor Indicates if the contact is a contractor. This is important if you need to use the taxable payment reporting feature. boolean

None.

PostalAddress The postal or mailing address for the contact. Address

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": null,
  "LastUpdatedId": null,
  "Salutation": "Mr.",
  "GivenName": "Joe",
  "MiddleInitials": null,
  "FamilyName": "Blogs",
  "Company": {
    "Id": null,
    "Name": "ACME Co",
    "Abn": "12345618",
    "LastUpdatedId": null,
    "LongDescription": "The ACME company Pty Ltd",
    "TradingName": "ACME 2",
    "CompanyEmail": "company@email.com",
    "_links": []
  },
  "PositionTitle": "BigBoss",
  "PrimaryPhone": "02 4444 5555",
  "MobilePhone": null,
  "HomePhone": "02 4567 7897",
  "Fax": null,
  "EmailAddress": null,
  "ContactId": "1234",
  "ContactManager": {
    "Id": null,
    "LastUpdatedId": null,
    "Salutation": "Mrs.",
    "GivenName": "Joanne",
    "MiddleInitials": "B",
    "FamilyName": "Blogs",
    "PositionTitle": "UberBoss",
    "_links": []
  },
  "IsPartner": false,
  "IsCustomer": false,
  "IsSupplier": false,
  "IsContractor": false,
  "PostalAddress": {
    "Street": "123 Acme Street",
    "City": "Sydney",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "Australia"
  },
  "_links": []
}

application/xml, text/xml

Sample:
<ContactAggregatePost xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <Id xsi:nil="true" />
  <Salutation>Mr.</Salutation>
  <GivenName>Joe</GivenName>
  <MiddleInitials xsi:nil="true" />
  <FamilyName>Blogs</FamilyName>
  <Company>
    <_links />
    <Id xsi:nil="true" />
    <Name>ACME Co</Name>
    <Abn>12345618</Abn>
    <LastUpdatedId xsi:nil="true" />
    <LongDescription>The ACME company Pty Ltd</LongDescription>
    <TradingName>ACME 2</TradingName>
    <CompanyEmail>company@email.com</CompanyEmail>
  </Company>
  <PositionTitle>BigBoss</PositionTitle>
  <PrimaryPhone>02 4444 5555</PrimaryPhone>
  <MobilePhone xsi:nil="true" />
  <HomePhone>02 4567 7897</HomePhone>
  <Fax xsi:nil="true" />
  <EmailAddress xsi:nil="true" />
  <ContactId>1234</ContactId>
  <ContactManager>
    <_links />
    <Id xsi:nil="true" />
    <Salutation>Mrs.</Salutation>
    <GivenName>Joanne</GivenName>
    <MiddleInitials>B</MiddleInitials>
    <FamilyName>Blogs</FamilyName>
    <PositionTitle>UberBoss</PositionTitle>
  </ContactManager>
  <IsPartner>false</IsPartner>
  <IsCustomer>false</IsCustomer>
  <IsSupplier>false</IsSupplier>
  <IsContractor>false</IsContractor>
  <PostalAddress>
    <Street>123 Acme Street</Street>
    <City>Sydney</City>
    <State>NSW</State>
    <Postcode>2000</Postcode>
    <Country>Australia</Country>
  </PostalAddress>
</ContactAggregatePost>

Response Information

Resource Description

InsertContactAggregateResult
Name Description Type Additional information
InsertedContactId The id of the newly created/inserted contact. integer

None.

LastUpdatedId The unique id associated with this update. This value is required to be passed in on subsequent updates to prevent concurrency errors. string

None.

LastModified The date and time this resource was modified in UTC. date

None.

CompanyId The unique id associated with the Company that was added or updated. integer

None.

CompanyLastUpdatedId The unique id associated with this update for the Company. This value is required to be passed in on subsequent updates to prevent concurrency errors. string

None.

ContactManagerId The unique id associated with the Contact Manager that was added or updated. integer

None.

ContactManagerLastUpdatedId The unique id associated with this update for the Contact Manager. This value is required to be passed in on subsequent updates to prevent concurrency errors. string

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "InsertedContactId": 234,
  "LastUpdatedId": "AAAAAFwWAN8=",
  "LastModified": "2017-02-27T20:47:07.5203172Z",
  "CompanyId": 789,
  "CompanyLastUpdatedId": "AAAAAFwWAX2=",
  "ContactManagerId": 233,
  "ContactManagerLastUpdatedId": "AAAAAFwWAS7=",
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/ContactAggregate/234?FileId=123",
      "method": "POST",
      "title": null
    },
    {
      "rel": "update",
      "href": "https://api.saasu.com/ContactAggregate/234?FileId=123",
      "method": "PUT",
      "title": null
    },
    {
      "rel": "detail",
      "href": "https://api.saasu.com/ContactAggregate/234?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "related",
      "href": "https://api.saasu.com/Contact/234?FileId=123",
      "method": "GET",
      "title": "Contact"
    }
  ]
}

application/xml, text/xml

Sample:
<InsertContactAggregateResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/ContactAggregate/234?FileId=123</href>
      <method>POST</method>
    </Link>
    <Link>
      <rel>update</rel>
      <href>https://api.saasu.com/ContactAggregate/234?FileId=123</href>
      <method>PUT</method>
    </Link>
    <Link>
      <rel>detail</rel>
      <href>https://api.saasu.com/ContactAggregate/234?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>related</rel>
      <href>https://api.saasu.com/Contact/234?FileId=123</href>
      <method>GET</method>
      <title>Contact</title>
    </Link>
  </_links>
  <InsertedContactId>234</InsertedContactId>
  <LastUpdatedId>AAAAAFwWAN8=</LastUpdatedId>
  <LastModified>2017-02-27T20:47:07.5203172Z</LastModified>
  <CompanyId>789</CompanyId>
  <CompanyLastUpdatedId>AAAAAFwWAX2=</CompanyLastUpdatedId>
  <ContactManagerId>233</ContactManagerId>
  <ContactManagerLastUpdatedId>AAAAAFwWAS7=</ContactManagerLastUpdatedId>
</InsertContactAggregateResult>