Sending PATCHes

You can use a request tool, such as Postman, to ensure PATCHes are well-formed and to review the structure of the response payloads. For more information on Postman, see Requests and responses.

Send a PATCH using Postman

Procedure

  1. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
  2. Specify Basic Auth authorization using user aapplegate and password gw.
  3. Under the Untitled Request label, select PATCH.
  4. In the Enter request URL field, enter the URL for the server and the endpoint for your respective InsuranceSuite application:
    • ClaimCenter: To patch activity cc:2 on an instance of ClaimCenter on your machine, enter: http://localhost:8080/cc/rest/common/v1/activities/cc:2
    • PolicyCenter: To patch activity pc:2 on an instance of PolicyCenter on your machine, enter: http://localhost:8180/pc/rest/common/v1/activities/cc:2
    • BillingCenter: To patch role billing_manager on an instance of BillingCenter on your machine, enter: http://localhost:8580/bc/rest/admin/v1/roles/billing_manager
  5. Specify the request payload.
    • In the first row of tabs (the one that starts with Params), click Body.
    • In the row of radio buttons, select raw.
    • At the end of the row of radio buttons, change the drop-down list value from Text to JSON.
    • Paste the request payload into the text field underneath the radio buttons.
  6. Click Send. The response payload appears below the request payload.

Tutorial: PATCH an activity

This tutorial assumes you have set up your environment with Postman and the correct sample dataset. For more information, see Tutorial: Set up your Postman environment.

In this tutorial, you will find an open activity from the sample data. You will then update the activity's subject and priority.

Note: This tutorial only applies to ClaimCenter and PolicyCenter. See Tutorial: PATCH an account for a tutorial that applies to BillingCenter.

Tutorial steps

  1. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
  2. On the Authorization tab, select Basic Auth using user aapplegate and password gw.
  3. The sample data will differ for ClaimCenter and PolicyCenter:
    • ClaimCenter: The sample data includes one "Get police report" activity for Andy Applegate, which can be PATCHed because it is an open activity on an open claim. Query for that activity by entering the following call and clicking Send:

      GET http://localhost:8080/cc/rest/common/v1/activities?filter=subject:sw:Get%20police%20report

    • PolicyCenter: The sample data includes one "Review risk information" activity for Alice Applegate. Query for that activity by entering the following call and clicking Send:

      GET http://localhost:8180/pc/rest/common/v1/activities?filter=subject:sw:Review%20risk

  4. For the activity in the response payload that is assigned to Andy/Alice Applegate, note the following information:
    1. Activity ID
    2. Priority
    3. Subject
  5. Open a second request tab. Right click the first tab and select Duplicate Tab.
  6. Change the operation to PATCH and enter the following URL for your respective InsuranceSuite application, but do not click Send yet:
    • ClaimCenter: PATCH http://localhost:8080/cc/rest/common/v1/activities/<activityID>
    • PolicyCenter: PATCH http://localhost:8180/pc/rest/common/v1/activities/<activityID>
  7. Specify the request payload.
    1. In the first row of tabs (the one that starts with Params), click Body.
    2. In the row of radio buttons, select raw.
    3. At the end of the row of radio buttons, change the drop-down list value from Text to JSON.
    4. For your respective InsuranceSuite application, paste the following into the text field underneath the radio buttons. Note that the subject has an additional "!" at the end:
      • ClaimCenter:
        {
  "data": {
    "attributes": {
      "subject" : "Get police report!",
      "priority": {
        "code": "low"
        }
    }
  }
}
      • PolicyCenter:
        {
  "data": {
    "attributes": {
      "subject" : "Review Risk informaton!",
      "priority": {
        "code": "low"
        }
    }
  }
}
  8. Click Send. The response payload appears below the request payload.

Checking your work

View the modified activity in your respective InsuranceSuite application:
  • ClaimCenter: Log on to ClaimCenter as the user aapplegate. Andy's landing page is the Activities screen, which shows the open activities assigned to him. It defaults to showing "My activities today". change the drop-down list at the top of the Activities screen to "All open".
  • PolicyCenter: Log on to PolicyCenter as the user aapplegate. In the left-hand side bar, click My Activities. PolicyCenter shows the My Activities screen, which shows the open activities assigned to Alice.

Click the Priority column to sort the activities in ascending priority order.

The PATCHed activity (whose priority is now Low) will be at or near the top of the list. The patched activity will have a subject ending with an "!".

Tutorial: PATCH an account

This tutorial assumes you have set up your environment with Postman and the correct sample dataset. For more information, see Tutorial: Set up your Postman environment.

In this tutorial, you will find an account from the sample data. You will then update the account's name.

Note: This tutorial only applies to BillingCenter. See Tutorial: PATCH an activity for a tutorial that applies to ClaimCenter and PolicyCenter.

Tutorial steps

  1. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
  2. On the Authorization tab, select Basic Auth using user aapplegate and password gw.
  3. The sample data includes one sample account called "Standard Account." Query for that account by entering the following call and clicking Send:

    GET http://localhost:8180/bc/rest/billing/v1/accounts?filter=accountNumber:eq:Standard%20Account

  4. For the account in the response payload, note the following information:
    • The account ID (id)
    • The account name (accountName)
  5. Open a second request tab. Right-click the first tab and select Duplicate Tab.
  6. Change the operation to PATCH and enter the following URL, but do not click Send yet:

    PATCH http://localhost:8180/bc/rest/billing/v1/accounts/<accountID>

  7. Specify the request payload.
    1. In the first row of tabs (the one that starts with Params), click Body.
    2. In the row of radio buttons, select raw.
    3. At the end of the row of radio buttons, change the drop-down list value from Text to JSON.
    4. Paste the following into the text field underneath the radio buttons. 
      {
    "data": {
        "attributes": {
            "accountName": "Updated Standard Account"
        }
    }
}
  8. Click Send. The response payload appears below the request payload.

Checking your work

View the modified activity in BillingCenter:

  1. Log into BillingCenter as the user aapplegate.
  2. Search for "Standard Account" in the Account # field.
  3. Select the account.

The PATCHed account now has the name "Updated Standard Account."