Requires the role: | manager |
POST | /employers |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Employer | form | Employer | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
BusinessDetails | form | BusinessDetails | No | |
Contact | form | Contact | No | |
PostalAddress | form | Address | No | |
PhysicalAddress | form | Address | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TradingName | form | string | No | |
AustralianBusinessNumber | form | string | No | |
AustralianCompanyNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ContactName | form | string | No | |
form | string | No | ||
PhoneNumber | form | string | No | |
PreferredContactMethod | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
Suburb | form | string | No | |
StateTerritory | form | string | No | |
Postcode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Employer | form | Employer | 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.
POST /employers HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"name":"String","organisationId":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"employer":{"name":"String","businessDetails":{"tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String"},"contact":{"contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String"},"postalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"physicalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"id":"String"}}