Getting partner information

Using a REST API, you can get information on a partner organization. Partner organization information is necessary for onboarding the partner to another application such as Sterling File Gateway.

Before you begin, you need REST client software. However, there is no requirement to use specific client software. One example of REST client software that can be used is a REST plug-in for the Mozilla Firefox browser.

  1. Open your REST client software.
    Important: Use the REST client software for the remainder of the commands in this procedure. However, it is necessary for correct permissions that you sign in to PEM Portal first.
  2. In the client software, select Authentication > Basic Authentication.
    Enter the user name and password into the fields that are provided, and click OK or a similar command in the client software.
  3. In the client software, select GET as the HTTP request method.
  4. Add two headers:
    • Accept : application/xml or Accept : application/json
    • Content-Type : application/xml or Content-Type : application/json
  5. Enter the following URL pattern to access the Partner get REST API: 
    
https://<PR IP>:<PR Port>/mdrws/sponsors/<sponsor-context>/partners/<partner key>
    Where:
    • <PR IP> is the IP address of your server
    • <PR Port> is a port number on the server
    Note: The URL can be different based on your deployment option. For more details about the URL, see URL for accessing IBM PEM and APIs.
  6. Click Send or a similar command in your client software to get the partner organization information.
    If the request was successful, you get a response with the status code HTTP/1.1 201 OK. This response means that the partner organization information was retrieved successfully.
  7. Open the body of the response to view the partner information.
    The following example shows the response for the company Acme with partner key c417b226-e457-4187-9956-28dc37ef5c55:
    
XML:
    <?xml version="1.0" encoding="UTF-8"?><Partner
      partnerKey="c417b226-e457-4187-9956-28dc37ef5c55" partnerUniqueId="12578990"
      userId="partner8@test.com" firstName="TestFN" lastName="TestLN"
      businessRole="BusinessRole" email="test@altemail.com" officePhone="876564567"
      mobilePhone="98765656656" furtherContacts="other contact info" nameOfCompany="Test
      Company5" streetAddress="Test Street 5" city="Test City 5" country="IN"
      state="Karnataka" zipCode="560101" headOfficePhone="1312321322142421"
      website="www.testcompany5.com"><customFields><PartnerCustomField
      fieldName="Field1" fieldValue="ff3d7bc9-7eb6-4755-826e-6706c4580202"/><PartnerCustomField fieldName="Field2"
      fieldValue="2d1ea7e8-d2be-460c-ba50-7be59e6e24e3"/></customFields></Partner>
JSON: 
{
        "partnerKey": "c417b226-e457-4187-9956-28dc37ef5c55",
        "partnerUniqueId": "12578990",
        "userId": "partner8@test.com",
        "firstName": "TestFN",
        "lastName": "TestLN",
        "businessRole": "BusinessRole",
        "email": "test@altemail.com",
        "officePhone": "876564567",
        "mobilePhone": "98765656656",
        "furtherContacts": "other contact info",
        "nameOfCompany": "Test Company5",
        "streetAddress": "Test Street 5",
        "city": "Test City 5",
        "country": "IN",
        "state": "Karnataka",
        "zipCode": "560101",
        "headOfficePhone": "1312321322142421",
        "website": "www.testcompany5.com",
        "customFields":
        [
            {
                "fieldName": "Field1",
                "fieldValue": "ff3d7bc9-7eb6-4755-826e-6706c4580202"
            },
            {
                "fieldName": "Field2",
                "fieldValue": "2d1ea7e8-d2be-460c-ba50-7be59e6e24e3"
            }
        ]
    }