How to: Create a Participant Type

For information about prerequisites, see Creating Participants.

Assuming there are no Participants in the system, the first Participant that you need to create is a Participant Tenant. The Participant Tenant can be the owner of any other Participant. The Participant type request takes a singular and plural name for the Participant. For the Tenant Participant, which is also the master Participant, both the singular and plural names are the same. Let's create the tenant Participant and call it worldlogistics.

The Participant API is asynchronous and event-driven. When creating a Participant Type, we recommend that you specify a callback URL on which you can receive a notification of the success of the creation of the Participant Type and notifications of the success of operations performed on Participants based on the Type.

To create a Participant type, call the Create Participant Type endpoint and pass a request body similar to the following:

{  
    "name": {  
        "singular": "worldlogistics",  
        "plural": "worldlogistics"  
    },  
    "ttl": "10d" 
}

After the Participant of type Tenant is created, you can create the other Participant types that are going to be part of the operations.

The next Participant type to create is a type that you can use to represent all the mobile devices that the organization owns.

To create the mobiledevice Participant type, call the Create Participant Type endpoint and pass a request body similar to the following:

{  
  "name": {  
    "singular":"mobiledevice",  
    "plural":"mobiledevices"  
  },  
  "category": \[  
    {  
      "name": "Devices",  
      "description": "Smart Phones used by drivers and warehouse employees",  
      "subCategory": [  
        "Smart Phones"  
      ]  
    }  
  ],  
  "ttl" : "10d"
}

Did this page help you?