| GET | /FormDirect/Employers | List employer details for some forms | List employer details for some forms. return form type and employer details. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuperFund | form | List<SuperFundInfo> | No | |
| TFN | form | List<TFNInfo> | No | |
| AccClaimsHistory | form | List<AccClaimsHistoryInfo> | No | |
| MOJ | form | List<MOJInfo> | No | |
| StandardMOJ | form | List<StandardMOJInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | EmployerReference |
| Name | form | string | Yes | Name for identify |
| IsDefault | form | boolean | No | If it's the default employer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ABN | form | string | No | |
| BusinessName | form | string | No | |
| BusinessABN | form | string | No | |
| SuperFundName | form | string | No | |
| SuperFundABN | form | string | No | |
| USI | form | string | No | |
| Phone | form | string | No | |
| SuperFundWebsite | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | EmployerReference |
| Name | form | string | Yes | Name for identify |
| IsDefault | form | boolean | No | If it's the default employer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ABN | form | string | No | |
| BusinessName | form | string | No | |
| BusinessAddress | form | string | No | |
| BusinessSuburb | form | string | No | |
| BusinessState | form | string | No | |
| BusinessPostcode | form | string | No | |
| BusinessEmail | form | string | No | |
| ContactPerson | form | string | No | |
| ContactPhone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | EmployerReference |
| Name | form | string | Yes | Name for identify |
| IsDefault | form | boolean | No | If it's the default employer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrganisationName | form | string | No | |
| ContactPersonName | form | string | No | |
| ContactPersonPhone | form | string | No | |
| ContactPersonEmail | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | EmployerReference |
| Name | form | string | Yes | Name for identify |
| IsDefault | form | boolean | No | If it's the default employer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ThirdPartyCustomerID | form | string | No | |
| ThirdPartyName | form | string | No | |
| ThirdPartyReference | form | string | No | |
| ReportType | form | string | No | |
| ServiceType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | EmployerReference |
| Name | form | string | Yes | Name for identify |
| IsDefault | form | boolean | No | If it's the default employer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ThirdPartyName | form | string | No | |
| ThirdPartyActingFor | form | string | No | |
| ThirdPartyReference | form | string | No | |
| ThirdPartyReturnAddressName | form | string | No | |
| ThirdPartyStreet | form | string | No | |
| ThirdPartySuburb | form | string | No | |
| ThirdPartyTown | form | string | No | |
| ThirdPartyState | form | string | No | |
| ThirdPartyPostCode | form | string | No | |
| ThirdPartyCountry | form | string | No |
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
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"}]}