Requires the role: | manager |
PUT | /employers/{Id}/business-details |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
TradingName | body | string | No | |
AustralianBusinessNumber | body | string | No | |
AustralianCompanyNumber | body | string | No | |
ContactName | body | string | No | |
body | string | No | ||
PhoneNumber | body | string | No | |
PreferredContactMethod | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /employers/{Id}/business-details HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
tradingName: String,
australianBusinessNumber: String,
australianCompanyNumber: String,
contactName: String,
email: String,
phoneNumber: String,
preferredContactMethod: String,
organisationId: String,
embed: String
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 } }