Secured Signing API

<back to all web services

UpdateEmployerRequest

The following routes are available for this service:
POST/FormDirect/UpdateEmployersSave employer details for some formsSave employer details for some forms
UpdateEmployerRequest Parameters:
NameParameterData TypeRequiredDescription
SuperFundbodyList<SuperFundInfo>No
TFNbodyList<TFNInfo>No
AccClaimsHistorybodyList<AccClaimsHistoryInfo>No
SuperFundInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesEmployerReference
NameformstringYesName for identify
IsDefaultformbooleanNoIf it's the default employer
SuperFundInfo Parameters:
NameParameterData TypeRequiredDescription
ABNformstringNo
BusinessNameformstringNo
BusinessABNformstringNo
SuperFundNameformstringNo
SuperFundABNformstringNo
USIformstringNo
PhoneformstringNo
SuperFundWebsiteformstringNo
TFNInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesEmployerReference
NameformstringYesName for identify
IsDefaultformbooleanNoIf it's the default employer
TFNInfo Parameters:
NameParameterData TypeRequiredDescription
ABNformstringNo
BusinessNameformstringNo
BusinessAddressformstringNo
BusinessSuburbformstringNo
BusinessStateformstringNo
BusinessPostcodeformstringNo
BusinessEmailformstringNo
ContactPersonformstringNo
ContactPhoneformstringNo
AccClaimsHistoryInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesEmployerReference
NameformstringYesName for identify
IsDefaultformbooleanNoIf it's the default employer
AccClaimsHistoryInfo Parameters:
NameParameterData TypeRequiredDescription
OrganisationNameformstringNo
ContactPersonNameformstringNo
ContactPersonPhoneformstringNo
ContactPersonEmailformstringNo
Employers Parameters:
NameParameterData TypeRequiredDescription
SuperFundformList<SuperFundInfo>No
TFNformList<TFNInfo>No
AccClaimsHistoryformList<AccClaimsHistoryInfo>No
MOJformList<MOJInfo>No
StandardMOJformList<StandardMOJInfo>No
MOJInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesEmployerReference
NameformstringYesName for identify
IsDefaultformbooleanNoIf it's the default employer
MOJInfo Parameters:
NameParameterData TypeRequiredDescription
ThirdPartyCustomerIDformstringNo
ThirdPartyNameformstringNo
ThirdPartyReferenceformstringNo
ReportTypeformstringNo
ServiceTypeformstringNo
StandardMOJInfo Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesEmployerReference
NameformstringYesName for identify
IsDefaultformbooleanNoIf it's the default employer
StandardMOJInfo Parameters:
NameParameterData TypeRequiredDescription
ThirdPartyNameformstringNo
ThirdPartyActingForformstringNo
ThirdPartyReferenceformstringNo
ThirdPartyReturnAddressNameformstringNo
ThirdPartyStreetformstringNo
ThirdPartySuburbformstringNo
ThirdPartyTownformstringNo
ThirdPartyStateformstringNo
ThirdPartyPostCodeformstringNo
ThirdPartyCountryformstringNo

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.

POST /FormDirect/UpdateEmployers HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateEmployerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <AccClaimsHistory xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:AccClaimsHistoryInfo>
      <ContactPersonEmail xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonEmail>
      <ContactPersonName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonName>
      <ContactPersonPhone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonPhone>
      <OrganisationName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</OrganisationName>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Reference>String</d2p1:Reference>
    </d2p1:AccClaimsHistoryInfo>
  </AccClaimsHistory>
  <SuperFund xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:SuperFundInfo>
      <ABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ABN>
      <BusinessABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessABN>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessName>
      <Phone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</Phone>
      <SuperFundABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundABN>
      <SuperFundName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundName>
      <SuperFundWebsite xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundWebsite>
      <USI xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</USI>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Reference>String</d2p1:Reference>
    </d2p1:SuperFundInfo>
  </SuperFund>
  <TFN xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:TFNInfo>
      <ABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ABN>
      <BusinessAddress xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessAddress>
      <BusinessEmail xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessEmail>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessName>
      <BusinessPostcode xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessPostcode>
      <BusinessState xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessState>
      <BusinessSuburb xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessSuburb>
      <ContactPerson xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPerson>
      <ContactPhone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPhone>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Reference>String</d2p1:Reference>
    </d2p1:TFNInfo>
  </TFN>
</UpdateEmployerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Employers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <AccClaimsHistory>
    <AccClaimsHistoryInfo>
      <ContactPersonEmail xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonEmail>
      <ContactPersonName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonName>
      <ContactPersonPhone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPersonPhone>
      <OrganisationName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</OrganisationName>
      <IsDefault>false</IsDefault>
      <Name>String</Name>
      <Reference>String</Reference>
    </AccClaimsHistoryInfo>
  </AccClaimsHistory>
  <MOJ>
    <MOJInfo>
      <ReportType xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ReportType>
      <ServiceType xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ServiceType>
      <ThirdPartyCustomerID xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyCustomerID>
      <ThirdPartyName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyName>
      <ThirdPartyReference xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyReference>
      <IsDefault>false</IsDefault>
      <Name>String</Name>
      <Reference>String</Reference>
    </MOJInfo>
  </MOJ>
  <StandardMOJ>
    <StandardMOJInfo>
      <ThirdPartyActingFor xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyActingFor>
      <ThirdPartyCountry xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyCountry>
      <ThirdPartyName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyName>
      <ThirdPartyPostCode xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyPostCode>
      <ThirdPartyReference xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyReference>
      <ThirdPartyReturnAddressName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyReturnAddressName>
      <ThirdPartyState xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyState>
      <ThirdPartyStreet xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyStreet>
      <ThirdPartySuburb xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartySuburb>
      <ThirdPartyTown xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ThirdPartyTown>
      <IsDefault>false</IsDefault>
      <Name>String</Name>
      <Reference>String</Reference>
    </StandardMOJInfo>
  </StandardMOJ>
  <SuperFund>
    <SuperFundInfo>
      <ABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ABN>
      <BusinessABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessABN>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessName>
      <Phone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</Phone>
      <SuperFundABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundABN>
      <SuperFundName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundName>
      <SuperFundWebsite xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</SuperFundWebsite>
      <USI xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</USI>
      <IsDefault>false</IsDefault>
      <Name>String</Name>
      <Reference>String</Reference>
    </SuperFundInfo>
  </SuperFund>
  <TFN>
    <TFNInfo>
      <ABN xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ABN>
      <BusinessAddress xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessAddress>
      <BusinessEmail xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessEmail>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessName>
      <BusinessPostcode xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessPostcode>
      <BusinessState xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessState>
      <BusinessSuburb xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</BusinessSuburb>
      <ContactPerson xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPerson>
      <ContactPhone xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Library.Objects">String</ContactPhone>
      <IsDefault>false</IsDefault>
      <Name>String</Name>
      <Reference>String</Reference>
    </TFNInfo>
  </TFN>
</Employers>