Secured Signing API

<back to all web services

EmployerListRequest

The following routes are available for this service:
GET/FormDirect/EmployersList employer details for some formsList employer details for some forms. return form type and employer details.
Employers Parameters:
NameParameterData TypeRequiredDescription
SuperFundformList<SuperFundInfo>No
TFNformList<TFNInfo>No
AccClaimsHistoryformList<AccClaimsHistoryInfo>No
MOJformList<MOJInfo>No
StandardMOJformList<StandardMOJInfo>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
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /FormDirect/Employers HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SuperFund":[{"Reference":"String","Name":"String","IsDefault":false,"ABN":"String","BusinessName":"String","BusinessABN":"String","SuperFundName":"String","SuperFundABN":"String","USI":"String","Phone":"String","SuperFundWebsite":"String"}],"TFN":[{"Reference":"String","Name":"String","IsDefault":false,"ABN":"String","BusinessName":"String","BusinessAddress":"String","BusinessSuburb":"String","BusinessState":"String","BusinessPostcode":"String","BusinessEmail":"String","ContactPerson":"String","ContactPhone":"String"}],"AccClaimsHistory":[{"Reference":"String","Name":"String","IsDefault":false,"OrganisationName":"String","ContactPersonName":"String","ContactPersonPhone":"String","ContactPersonEmail":"String"}],"MOJ":[{"Reference":"String","Name":"String","IsDefault":false,"ThirdPartyCustomerID":"String","ThirdPartyName":"String","ThirdPartyReference":"String","ReportType":"String","ServiceType":"String"}],"StandardMOJ":[{"Reference":"String","Name":"String","IsDefault":false,"ThirdPartyName":"String","ThirdPartyActingFor":"String","ThirdPartyReference":"String","ThirdPartyReturnAddressName":"String","ThirdPartyStreet":"String","ThirdPartySuburb":"String","ThirdPartyTown":"String","ThirdPartyState":"String","ThirdPartyPostCode":"String","ThirdPartyCountry":"String"}]}