PersonGroupMemberWebService

PersonGroupMemberWebService

GroupMemberWebServiceService
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/person/groupmemberwebservice
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

GroupMemberWebServiceService

Default

Up
get /documentation
service definition (getServiceDocumentation)
service definition

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Success String

GroupMemberWebServiceService

Up
post /{group_id}/{person_id}/{expiration_date}
The user supplies the group ID, person ID, and (optionally) the expiration_date. The group membership record is created. The user must have administrator rights to the group. (addGroupMember)
The user supplies the group ID, person ID, and (optionally) the expiration_date. The group membership record is created. The user must have administrator rights to the group.

Path parameters

group_id (required)
Path Parameter x2014; string ->
person_id (required)
Path Parameter x2014; string ->
expiration_date (required)
Path Parameter x2014; string ->

Query parameters

person_id (required)
Query Parameter x2014; string ->
group_id (required)
Query Parameter x2014; string ->
expiration_date (required)
Query Parameter x2014; string ->

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
delete /{group_id}/{person_id}
The user supplies the group ID and person ID. The group membership record is deleted. The user must have administrator rights to the group. (delete Group Member)
The user supplies the group ID and person ID. The group membership record is deleted. The user must have administrator rights to the group.

Path parameters

group_id (required)
Path Parameter x2014; string ->
person_id (required)
Path Parameter x2014; string ->

Query parameters

person_id (required)
Query Parameter x2014; string ->
group_id (required)
Query Parameter x2014; string ->

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
put /{group_id}/{person_id}/{expiration_date}
The user supplies the group ID, person ID, and the expiration_date. The expiration date in the group membership record is updated. The user must have administrator rights to the group. (updateGroupMember)
The user supplies the group ID, person ID, and the expiration_date. The expiration date in the group membership record is updated. The user must have administrator rights to the group.

Path parameters

group_id (required)
Path Parameter x2014; string ->
person_id (required)
Path Parameter x2014; string ->
expiration_date (required)
Path Parameter x2014; string ->

Query parameters

person_id (required)
Query Parameter x2014; string ->
group_id (required)
Query Parameter x2014; string ->
expiration_date (required)
Query Parameter x2014; string ->

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Models

[ Jump to Methods ]

Table of Contents

Service Path: 
/domains/legacy/person/groupmemberwebservice
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!