| Requires any of the roles: | member, oauthmember | Required permission: | CanHaveBuddyList |
| GET | /Ams/{ClientID}/Member/{MemberID}/Connections | Return a list of member connections filtered by status. | |
|---|---|---|---|
| POST | /Ams/{ClientID}/Member/{MemberID}/Connections | Send a connection request to another member. | |
| PUT | /Ams/{ClientID}/Member/{MemberID}/Connections | Approve a pending request. | |
| DELETE | /Ams/{ClientID}/Member/{MemberID}/Connections/{ConnectionId} | Remove an existing connection or pending request. | |
| PUT | /Ams/{ClientID}/Member/{MemberID}/Connections/{ConnectionId} | Approve a pending request. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionFilter | body | ConnectionFilter? | No | Allowable Values
|
| ConnectionId | path | int | No | |
| CategoryId | body | int? | No | |
| PageSize | body | int | No | |
| PageNumber | body | int | No | |
| OffSet | body | int | No | |
| Message | body | string | No | |
| NameTerm | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionsList | form | List<Connection> | No | |
| ConnectionStatus | form | ConnectionStatus? | No | |
| Success | form | bool? | No | |
| TotalResultsCount | form | int | No | |
| TargetMemberName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionStatus | form | ConnectionStatus? | No | |
| ConnectionId | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| ConnectionName | form | string | No | |
| Organization | form | string | No | |
| HeadShotImage | form | string | No | |
| WorkTitle | form | string | No | |
| MemberType | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Location | form | string | No | |
| Country | form | string | No | |
| Shared | form | bool | No | |
| form | string | No | ||
| PhoneLabel | form | string | No | |
| PhoneAreaCode | form | string | No | |
| PhoneNumber | form | string | No | |
| FaxLabel | form | string | No | |
| FaxAreaCode | form | string | No | |
| FaxNumber | form | string | No | |
| CanShow | form | ShowPreferences | No | |
| intCategoryID | form | int | No | |
| IsAmbassador | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | bool | No | |
| Location | form | bool | No | |
| Country | form | bool | No | |
| Phone | form | bool | No | |
| Fax | form | bool | No | |
| form | bool | No | ||
| EmployerName | form | bool | No | |
| EmployerTitle | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/Member/{MemberID}/Connections HTTP/1.1
Host: ws.yourmembership.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ConnectionFilter":"0","ConnectionId":0,"CategoryId":0,"PageSize":0,"PageNumber":0,"OffSet":0,"Message":"String","NameTerm":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T04:04:57.3800279-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ConnectionsList":[{"ConnectionStatus":"None","ConnectionId":0,"FirstName":"String","LastName":"String","ConnectionName":"String","Organization":"String","HeadShotImage":"String","WorkTitle":"String","MemberType":"String","City":"String","State":"String","Location":"String","Country":"String","Shared":false,"Email":"String","PhoneLabel":"String","PhoneAreaCode":"String","PhoneNumber":"String","FaxLabel":"String","FaxAreaCode":"String","FaxNumber":"String","CanShow":{"City":false,"Location":false,"Country":false,"Phone":false,"Fax":false,"Email":false,"EmployerName":false,"EmployerTitle":false},"intCategoryID":0,"IsAmbassador":false}],"ConnectionStatus":"None","Success":false,"TotalResultsCount":0,"TargetMemberName":"String","ConnectionFilter":"0","ConnectionId":0,"CategoryId":0,"PageSize":0,"PageNumber":0,"OffSet":0,"Message":"String","NameTerm":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T04:04:57.3800279-04:00","Device":"Desktop"}