2.1.1 Actor object abstract
Represents an actor in the Drillster platform. Actors come in two flavors:
- 2.1.1 User
- 2.1.1 Organization
Example
{
"type": "ORGANIZATION",
"id": "nPjYUn0upc8dIm7yzTIBgQ",
"name": "Acme Corp",
"avatar": {
"type": "image/png",
"url": "https://www.drillster.com/bin/avatar/05105d2b6585d1e1efe2b5491347375b95e2c6123"
},
"emailAddress": "info@acme.example.com",
"locale": "en_US"
}
Fields
Field | Type | Description |
---|---|---|
type required |
String | The type of actor. This can either be USER or ORGANIZATION . |
id required |
String | The actor's ID. Example value: nPjYUn0upc8dIm7yzTIBgQ . |
name required |
String | The actor's name. |
avatar optional |
2.1.1 Media object | An optional avatar to represent the actor. |
emailAddress optional |
String | The primary email address of the actor. Example value: info@acme.example.com |
locale optional |
String | An optional locale code for this actor. This may be a language code only, or a combination of language and country codes. Example value: en or en_US |
domicile optional |
String | An optional country code that reflects the domicile of this actor. This should be an upper case ISO 3166-1 country code. Example value: US or FR |
Last updated on