Arlo

REST Auth API: ContactEmployment

ContactEmployment resources are a subresource of Contact, and describe the employment relationship between a Contact and an Organisation resource.

The relationship is defined by metadata describing the individual's position and department within the associated organisation, as well as details about the branch and regional information.

ContactEmployment instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/contacts/{ContactID}/employment/

Resource properties

Property Description
Position A string describing the position of this individual within the organisation, up to 64 characters long.
Department A string describing the department this individual is associated with in the organisation, up to 64 characters long.
Branch A string describing the branch of the organisation that employs this individual, up to 64 characters long.
BusinessRegion A string describing the business region this individual is associated with, up to 64 characters long.
BusinessLocation A string describing the location of the business this individual is associated with, up to 64 characters long.
BusinessArea A string describing the area of the business this individual is associated with, up to 64 characters long.
EmploymentStatus A string describing the type of employment such as Contractor or Consultant, up to 64 characters long.

HTTP GET

Returns a representation of a ContactEmployment, including the properties and links above.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
Example

GET /demo/api/2012-02-01/auth/resources/contacts/562/employment/

<ContactEmployment>
  <Position>Marketing Site Developer</Position>
  <Department>Marketing</Department>
  <Branch>Auckland</Branch>
  <BusinessRegion>New Zealand - North</BusinessRegion>
  <BusinessArea>New Zealand - North</BusinessArea>
  <EmploymentStatus>Contractor, full time</EmploymentStatus>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/8/employment/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" type="application/xml" title="Contact" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/8/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Organisation" type="application/xml" title="Organisation" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/organisations/2/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Manager" type="application/xml" title="Manager" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/328/"/>
</ContactEmployment>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.