Method: PUT
Objective: Provide the ability to update partner company based on information provided.
Usage:
This will be the PUT request.
The service URL to be used will be: http://<environment url>/ws/rest/service/v1/admin/company
Input:
Company information in JSON format.
Sample JSON to update Partner company
{
"companyname":"Partner Company - 01",
"shortname":"partner01",
"addresses": [{
"addresstype": 1,
"addressline1":"488 Almaden Blvd",
"city":"San Jose",
"state":"CA",
"zip":"95110",
"country":"US"
}],
"passwordpolicy":{
"min_length": 1,
"max_length": 3
}
}
Output:
If the service runs successfully, then the return data will be Status and message.
The mandatory existing validations that exist for updating partner company will be applicable in REST service as well
The shortname is the identifier for updating the partner company details.
The other data elements which are not included as part of the update request will retain its value on execution.
Validations for updating partner company
Status | Condition | Message |
|---|---|---|
200 | Success | The partner company {partner company name} has been created. |
901 | Invalid data value | Invalid data for <data_element>. |
902 | Partner company specified does not exist as shortname specified is not matching. | The partner company does not exist.
|
5555 | One or more records contain errors. | One or more records contain errors. |