Developing a Client Application to Retrieve Supplier-Inviter Mapping Information

Use this procedure to develop a client application to retrieve supplier-inviter mapping information. The inviter element of the invitedSuppliers array in the response of GET /entity_type/entity_id endpoint provides information about the buyer user who invited the supplier to the event.

Prerequisites

Context

To retrieve the invitedSuppliers array, query the endpoint
GET /entity_type/entity_id
            
with the $select=invitedSuppliers parameter set.

Procedure

  1. Obtain the following information:
    entity_type
    Type of document from which you want to retrieve the supplier-inviter information.
    entity_id
    ID of document from which you want to retrieve the supplier-inviter information.
  2. Implement the following endpoint with the $select parameter set to invitedSuppliers:
    GET {{runtime_url}}/entity_type/entity_id?realm=realm_name&$select=invitedSuppliers

    where entity_type denotes the document type and entity_id denotes the document ID.

    Request example:
    GET {{runtime_url}}/RFXDocument/Doc12345?realm=MyRealm&$select=invitedSuppliers

    The inviter element of the invitedSuppliers array provides information about the buyer user who invited the supplier to the event.

    Response example:
    	...
    		"invitedSuppliers": {
    			...
    			"inviter"{
    				"uniqueName": "user1"
    				"passwordAdapter": "passwordadapter1"                    },
                  }
    			...
    		}
    	...
    where uniqueName and passwordAdapter contain the name and the password adapter, respectively, of the user that invited the supplier to the event.