The Workshop Master API can create a workshop with a master id, corresponding to unique workshop in Bosch CRM based on region/country.

Overview

Http Method

POST

Authentication

Basic Auth.

Http Status Codes

200 - OK with data in response body

400 - In case your request is malformed or contains insufficient information - Bad Request (Validation error)

401 - Wrong or missing auth header

403 - In case of Invalid User trying to access the information

50x - Internal Server Error
Versioning

The initial API version is v1.0, and is namespaced into endpoint route -
https://bosch-garage-management.com/WSMS_Q_WorkshopMasterAPI/api/WorkshopMaster/CreateWorkshopMaster.
The API version will be increased due to a backwards-incompatible changes.v

Schema

All information is sent and received as JSON data interchange format over HTTPS. Timestamps in API responses will always include timezone (typically UTC). Always provide timezones in API requests (preferably UTC).

Http Path

https://bosch-garage-management.com/WSMS_Q_WorkshopMasterAPI/api/WorkshopMaster/CreateWorkshopMaster

Http Path Parameters

None

Header Parameters

None

Request Parameters

None

Request Fields
FieldName DataType Mandatory Description DataLength Remarks

Workshop ID

varchar

Yes

Unique workshop Identifier in Local WSMS

20

Primary Key

Workshop Name

varchar

No

Name of the workshop

100

Workshop Name (Local lang)

Nvarchar

No

Name of the workshop if other than English language if applicable

100

Workshop CRM ID

varchar

Yes

Unique workshop Id in Bosch CRM

15

Created Date

Date (DDMMYYYY)

Yes

Workshop onboarding date in WSMS

Region

varchar

Yes

Region of the workshopp

10

Predefined values

Sub Region

varchar

Yes

sub region of the Workshop

50

Predefined values

Country

varchar

Yes

Country of the workshop

50

Predefined values

Sub Country

varchar

Yes

state/country of the workshop

50

Sub Country (Local lang)

varchar

No

Name of the sub country if other than English language if applicable

50

Area Manager

varchar

Yes

Manager of the workshop

50

Postcode

varchar

No

Postal code

10

System

varchar

Yes

WSMS system used

20

Workshop Category

varchar

Yes

Category of the Workshop

30

Predefined values

Status

varchar

Yes

Status of the workshop (Active/Inactive/Frozen)

20

Predefined values
Request Body
{
    "WorkshopId": "w999",
    "WorkshopName": "Test251",
    "WorkshopNameLocalLanguage": "NA",
    "WorkshopCRMID": "C964",
    "CreatedDate": "11/10/2022",
    "Region": "Tesia",
    "SubRegion": "NA",
    "Country": "au",
    "SubCountry": "Victoria998",
    "SubCountryLocalLanguage": "NA",
    "AreaManager": "Jason Ingram",
    "Postcode": 474,
    "System": "NA",
    "WorkshopCategory": "NA",
    "Status": "AAAA"
    }
Response Headers

None

Responses

201 OK

{
    {
    "message": "Record(s) processed partailly.",
    "totalRecords": 2,
    "failedRecords": 1,
    "successRecords": 1,
    "processedFailedRecords": [
    {
    "workshopId": "w55",
    "workshopName": "Test",
    "workshopNameLocalLanguage": "NA",
    "workshopCRMID": "C20",
    "createdDate": "2022-10-11T00:00:00",
    "region": "Tesia",
    "subRegion": "NA",
    "country": "au",
    "subCountry": "Victoria54",
    "subCountryLocalLanguage": "NA",
    "areaManager": "Jason Ingram",
    "postcode": "234",
    "system": "NA",
    "workshopCategory": "NA",
    "status": "AAAA",
    "errorMessage": "Duplicate workshopId"
    }
  }

Authentication

Authorization

The API endpoint requires client authorization. Every request must select Basic Auth mode from Authorization section if using Postman Application and provide the username and password.

Content type of request payload

All information is sent and received as JSON data interchange format over HTTPS. Every request must select raw json as a data format for the request payload from the body section if using Postman Application and specify the content accordingly.

API Specification

Steps to use Postman Application to send the API Post Http Request

1. Open Postman:
• Launch the Postman application.

2. Create a New Request:
• In the Postman app, click on the "New" button (usually located at the top-left corner) to create a new request.

3. Choose the Request Type:
• In the request editor, you will see a dropdown menu next to the URL field. Select "POST" from this dropdown.

4. Enter the Request URL:
• In the URL field (located next to the request type dropdown), enter the URL of the endpoint where you want to send the POST request. Make sure it's the correct URL for the API or service you are working with.

5. Authentication:
• As the API requires authentication, you can set it up in the "Authorization" tab.Click on the "Basic Auth" from dropdown, and enter the username and password.

6. Configure the Request Body:
• In the "Body" tab, select "raw" and choose "JSON (application/json)" as the data format. Enter your JSON data in the provided text field.

7. Send the Request:
• Once you've configured all the necessary details for your POST request, click the "Send" button (usually a blue "Send" button located at the top-right corner). Postman will send the POST request to the specified URL with the provided headers and payload.

8. View the Response:
• Postman will display the response from the server, including the status code, headers, and response body. You can review the response to ensure that your request was successful

Postman call request payload
 [
    {
    "WorkshopId": "w1",
    "WorkshopName": "test",
    "WorkshopNameLocalLanguage": "NA",
    "WorkshopCRMID": "76191859",
    "CreatedDate": "11/10/2022",
    "Region": "Tesia",
    "SubRegion": "NA",
    "Country": "au",
    "SubCountry": "Victoria",
    "SubCountryLocalLanguage": "NA",
    "AreaManager": "Jason Ingram",
    "Postcode": "3198",
    "System": "NA",
    "WorkshopCategory": "NA",
    "Status": "AAAA"
    }
  ]
Postman HTTP response body

    HTTP/1.1 200 OK
    {
    "message": "Record(s) processed partailly.",
    "totalRecords": 2,
    "failedRecords": 1,
    "successRecords": 1,
    "processedFailedRecords": [
    {
    "workshopId": "w55",
    "workshopName": "Test",
    "workshopNameLocalLanguage": "NA",
    "workshopCRMID": "C20",
    "createdDate": "2022-10-11T00:00:00",
    "region": "Tesia",
    "subRegion": "NA",
    "country": "au",
    "subCountry": "Victoria54",
    "subCountryLocalLanguage": "NA",
    "areaManager": "Jason Ingram",
    "postcode": "234",
    "system": "NA",
    "workshopCategory": "NA",
    "status": "AAAA",
    "errorMessage": "Duplicate workshopId"
    }
   ]
  }