Intervals API Resource: personcontact

The base URL for this resource is located at
https://api.myintervals.com/personcontact/

For accessing and updating contact information about people. This includes phone numbers, email addresses, physical addresses, websites, etc.

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive

Allowed Filters
Filter Name	Required?	Expects	Default	Description
personid	yes	integer
contacttypeid	no	integer
contactdescriptorid	no	integer

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To filter the list based on certain parameters:

GET /personcontact/?personid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive
DELETE	Administrator, Manager, Resource, Executive
POST	Administrator, Manager, Resource, Executive
PUT	Administrator, Manager, Resource, Executive

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
personid	yes	integer		The ID of the person to whom this contact information applies. Keep in mind only administrators may edit other people's contact information.
value	yes	string
contacttypeid	yes	integer
contactdescriptorid	yes	integer

string (xxx) indicates a string with a maximum length of xxx characters.

Examples

To retrieve one member resource:

GET /personcontact/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

To delete a particular member resource:

DELETE /personcontact/{id}/

Assuming no errors, the server will respond with 200 OK.

To create a new member resource:

POST /personcontact/

{
    "personid": value,
    "value": value,
    "contacttypeid": value,
    "contactdescriptorid": value
}

Assuming no errors, the server will respond with 201 Created and the newly-created element. This will allow you to get the id of the item you just created and verify the field values. Note: Only required fields were listed here. The entire list of possible fields is above.

To update a member resource:

PUT /personcontact/{id}/

{
    "value": value,
    "contacttypeid": value
}

Assuming no errors, the server will respond with 202 Accepted and the entire element. This will allow you to verify the field values.