IdentityPersonPROLanguage

LanguageService

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/identity/person/PRO/language

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/delete/{person_id}/{language_code} DELETE

Delete language of an individual with language code

/documentation GET

service definition

/{person_id} GET

Retrieve language of an individual

/{person_id}/ES* PUT

Update language for an individual

Paths

Delete language of an individual with language code

DELETE /delete/{person_id}/{language_code}

Tags: LanguageService

Delete language of an individual with language code

person_id

string -> nine digit number

path string
language_code

Language code

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

500 Internal Server Error

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

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Retrieve language of an individual

GET /{person_id}

Tags: LanguageService

Retrieve language of an individual

person_id

string -> nine digit number

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"LanguageService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"languages": [
{
"description": "English",
"language_code": "EN",
"read_proficiency": "H",
"speak_proficiency": "H",
"translator": "N",
"write_proficiency": "H"
}
]
,
"message": ""
}
}
}
400 Bad Request

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.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

500 Internal Server Error

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

Update language for an individual

PUT /{person_id}/ES*

Tags: LanguageService

Update language for an individual

person_id

string -> nine digit number

path string
speak_proficiency

Capability at speaking language

query string , x ∈ { H , M , L }
read_proficiency

Capability at reading language

query string , x ∈ { H , M , L }
write_proficiency

Capability at writing language

query string , x ∈ { H , M , L }
native_speaker

This person is a native speaker

query string , x ∈ { Y , N }
translator

This person is a native speaker

query string , x ∈ { Y , N }

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

500 Internal Server Error

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

Schema definitions

documentation: object

WebService: object
name: string
operations: operations
errors: errors
httpStatusCodes: httpStatusCodes

errors: object[]

object
code: integer
name: string
message: string
httpStatusCode: integer

httpStatusCodes: object[]

object
code: integer
message: string

langService: object

LanguageService: object
request: request
response: response

languages: object[]

object
language_code: string
description: string
speak_proficiency: string
read_proficiency: string
write_proficiency: string
translator: string

LanguageService2: object

request: object
method: object
resource: object
attributes: object
status: number
statusMessage: object
response: object
message: string
languages: object[]
object
language_code: string
description: string
speak_proficiency: string
read_proficiency: string
write_proficiency: string
translator: string

operations: object[]

object
name: string
description: string
method: string
path: string
path_identifiers: object[]
object
name: string
type: string
format: string
query_attributes: object[]
object
name: string
type: string
format: string
required: string

request: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

response: object

message: string
languages: languages
Service Path: 
/domains/legacy/identity/person/PRO/language
Domain or University API: 
/domains/D/identity/person/PRO/language

Community

 

Don't see your question listed here? Ask!