Sending POSTs

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

Send a POST using Postman

Procedure

  1. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
  2. Specify the appropriate authorization information.
  3. Under the Untitled Request label, make sure that POST is selected.
  4. In the Enter request URL field, enter the URL for the server and the endpoint. For example, to create a new note for activity xc:2 on your respective InsuranceSuite application, enter one of the following:
    • ClaimCenter: http://localhost:8180/cc/rest/common/v1/activities/cc:2/notes
    • PolicyCenter: http://localhost:8180/pc/rest/common/v1/activities/pc:101/notes
    • BillingCenter: http://localhost:8180/bc/rest/common/v1/activities/bc:101/notes
  5. 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 request payload into the text field underneath the radio buttons.
  6. Click Send. The response payload appears below the request payload.

Tutorial: Create a new note that specifies required fields only

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

In this tutorial, you will create a note whose subject is "API tutorial note 1" for an existing activity (an existing account in BillingCenter). The other fields will not be specified and will be assigned default values by the application (such as not being confidential and having a subject of "General").

If you're using BillingCenter, you must also specify the subject as "Test note" and the language code as en_US.

Tutorial steps

  1. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
    1. On the Authorization tab, select Basic Auth using user aapplegate and password gw.
  2. Enter the following call for your respective InsuranceSuite application and click Send:
    • ClaimCenter: GET http://localhost:8080/cc/rest/common/v1/activities
    • PolicyCenter: GET http://localhost:8080/pc/rest/common/v1/activities?filter=subject:eq:Review%20submission

      In the PolicyCenter example, Alice Applegate has two "Review submission" activities that you're retrieving.

    • BillingCenter: GET http://localhost:8080/bc/rest/billing/v1/accounts
  3. For your respective InsuranceSuite application, do the following:
    • ClaimCenter and PolicyCenter: Identify the id of the first activity in the payload. This value is referenced below as <activityId>.
    • BillingCenter: Identify the id of the first account in the payload. This value is referenced below as <accountId>.
  4. Open a second request tab. Right-click the first tab and select Duplicate Tab.
  5. Change the operation to POST and enter the following URL for your respective InsuranceSuite application, but don't click Send yet:
    • ClaimCenter: POST http://localhost:8080/cc/rest/common/v1/activities/<activityId>/notes
    • PolicyCenter: POST http://localhost:8180/pc/rest/common/v1/activities/<activityId>/notes
    • BillingCenter: POST http://localhost:8180/bc/rest/billing/v1/accounts/<accountId>/notes
  6. 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 for your respective InsuranceSuite application underneath the radio buttons.

      ClaimCenter, PolicyCenter:

      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 1"
                }
        }
}

      BillingCenter:

      {
    "data": {
        "attributes": {
            "language": {
                "code": "en_US"
            },
            "subject": "Test note",
            "body": "API tutorial note 1"
        }
    }
}
  1. Click Send. The response payload appears below the request payload.

Checking your work

View the new note in your respective InsuranceSuite application. Follow the appropriate steps:
  • ClaimCenter:
    1. In the response payload, note the claim number of the claim this note is related to. (It is the value of the relatedTo.displayName field.)
    2. Log on to ClaimCenter as aapplegate.
    3. On the Claim tab, click the drop-down arrow. Enter the claim number in the Claim # field and press Enter.
    4. In the left-hand sidebar, click Notes.
    5. The API tutorial note is listed as one of the notes.
  • PolicyCenter:
    1. Log on to PolicyCenter as aapplegate and click My Activities.
    2. Click the Subject header to sort the activities by subject.
    3. Find the first activity with the "Review submission", and click the subject. PolicyCenter opens an Activity Detail worksheet in the bottom pane.
    4. Click View Notes.
    5. The API tutorial note is listed as one of the notes. If the note is not present, check the second "Review submission" activity.
  • BillingCenter:
    1. In the response payload, note the id of the account the note is related to.
    2. Log on to BillingCenter as su
    3. On the account tab, click the drop-down error. Enter the account number in the Acct # field and press Enter.
    4. The API tutorial note is listed as one of the notes in the Notes section.

Tutorial: Create a new note that specifies optional fields

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

In this tutorial, you will create a note whose subject is "API tutorial note 2" for an existing activity (an existing account in BillingCenter). You will also specify values for two optional fields for your respective InsuranceSuite application:

  • ClaimCenter: confidential (set to true) and topic (set to "Litigation")
  • PolicyCenter: confidential (set to true) and topic (set to "Legal")
  • BillingCenter: confidential (set to true) and topic (set to "Delinquency")

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. Enter the following call for your respective InsuranceSuite application and click Send:
    • ClaimCenter: GET http://localhost:8080/cc/rest/common/v1/activities
    • PolicyCenter: GET http://localhost:8080/pc/rest/common/v1/activities?filter=subject:eq:Review%20submission

      In the PolicyCenter example, Alice Applegate has two "Review submission" activities that you're retrieving.

    • BillingCenter: GET http://localhost:8080/bc/rest/billing/v1/accounts
  4. For your respective InsuranceSuite application, do the following:
    • ClaimCenter and PolicyCenter: Identify the id of the first activity in the payload. This value is referenced below as <activityId>.
    • BillingCenter: Identify the id of the first account in the payload. This value is referenced below as <accountId>.
  5. Open a second request tab. Right-click the first tab and select Duplicate Tab.
  6. Change the operation to POST and enter the following URL for your respective InsuranceSuite application, but don't click Send yet:
    • ClaimCenter: POST http://localhost:8080/cc/rest/common/v1/activities/<activityId>/notes
    • PolicyCenter: POST http://localhost:8180/pc/rest/common/v1/activities/<activityId>/notes
    • BillingCenter: POST http://localhost:8180/bc/rest/billing/v1/accounts/<accountId>/notes
  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:

      ClaimCenter:

      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 2",
                "confidential": true,
                "topic": {
                    "code": "litigation"
                }
            }
        }
}

      PolicyCenter:

      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 2",
                "confidential": true,
                "topic": {
                    "code": "legal"
                }
            }
        }
}

      BillingCenter:

      {
    "data": {
        "attributes": {
            "language": {
                "code": "en_US"
            },
            "subject": "Note 2 subject",
            "body": "API tutorial note 2",
            "confidential": true,
            "topic": {
                "code": "delinquency"
            }
        }
    }
}
  8. Click Send. The response payload appears below the request payload.

Checking your work

View the new note in your respective InsuranceSuite application. Follow the appropriate steps:
  • ClaimCenter:
    1. In the response payload, note the claim number of the claim this note is related to. (It is the value of the relatedTo.displayName field.)
    2. Log on to ClaimCenter as aapplegate.
    3. On the Claim tab, click the drop-down arrow. Enter the claim number in the Claim # field and press Enter.
    4. In the left-hand sidebar, click Notes.
    5. The API tutorial note is listed as one of the notes. This note is confidential and it has the category specified in the request payload.
  • PolicyCenter:
    1. Log on to PolicyCenter as aapplegate and click My Activities.
    2. Click the Subject header to sort the activities by subject.
    3. Find the first activity with the "Review submission", and click the subject. PolicyCenter opens an Activity Detail worksheet in the bottom pane.
    4. Click View Notes.
    5. The API tutorial note is listed as one of the notes. This note is confidential and it has the category specified in the request payload. If the note is not present, check the second "Review submission" activity.

  • The API tutorial note is listed as one of the notes. If the note is not present, check the second "Review submission" activity.

  • BillingCenter:
    1. In the response payload, note the id of the account the note is related to.
    2. Log on to BillingCenter as su
    3. On the account tab, click the drop-down error. Enter the account number in the Acct # field and press Enter.
    4. The API tutorial note is listed as one of the notes in the Notes section. This note is confidential and it has the category specified in the request payload.