IdentityPersonLanguage

LanguageService

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id} GET

Shows the current Academic Standing of the student identified by the person id.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Shows the current Academic Standing of the student identified by the person id.

GET /{person_id}

Tags: LanguageService

Shows the current Academic Standing of the student identified by the person id.

person_id

string -> nine digit number

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Language Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": "200"
}
,
"resource": {
"URI": "/[delete/][peronsid[/]][language_code]",
"attributes": {
"native_speaker": {
"default": false,
"description": "A boolean string indicator. If ture (has a value) you will be considered to be a native speaker of the identified language.",
"required": false
}
,
"read_proficiency": {
"default": "N",
"description": "Self assested proficiency in reading the identified language",
"required": false,
"values": [
{
"code": "H",
"description": "High proficiency"
},
{
"code": "M",
"description": "Moderate proficiency"
},
{
"code": "L",
"description": "Low proficiency"
},
{
"code": "N",
"description": "No proficiency"
}
]
}
,
"speak_proficiency": {
"default": "N",
"description": "Self assested proficiency in speaking the identified language",
"required": false,
"values": [
{
"code": "H",
"description": "High proficiency"
},
{
"code": "M",
"description": "Moderate proficiency"
},
{
"code": "L",
"description": "Low proficiency"
},
{
"code": "N",
"description": "No proficiency"
}
]
}
,
"translator": {
"default": false,
"description": "A boolean string indicator. If ture (has a value) you will be considered to be capabile acting as a translator for this language.",
"required": false
}
,
"write_proficiency": {
"default": "N",
"description": "Self assested proficiency in writing the identified language",
"required": false,
"values": [
{
"code": "H",
"description": "High proficiency"
},
{
"code": "M",
"description": "Moderate proficiency"
},
{
"code": "L",
"description": "Low proficiency"
},
{
"code": "N",
"description": "No proficiency"
}
]
}
}
,
"examples": [
"/",
"/123456789",
"/delete/123456789/ES"
]
,
"identifiers": {
"language_code": {
"conditions": "Required on a PUT or DELETE",
"description": "Unique identifier of a managed language as defined by the Domain Value service",
"required": false,
"service": "codeMaintenance.cgi/LANGUAGE"
}
,
"personid": {
"default": "Identifier of authenticated entity",
"description": "Unique identifier of an entity",
"required": false
}
}
,
"methods": {
"adaptations": [
{
"PUT": [
"Tunnel through a GET with attributes in the query string name value pairs",
"Tunnel through a POST with attributes in POST content name values pairs"
]
},
{
"DELETE": "Tunnel through a GET with a resource identifier of /delete at the beginning"
}
]
,
"options": [
"GET",
"PUT",
"DELETE"
]
}
}
,
"response": {
"Languages": [
{
"description": "English",
"language_code": "EN",
"native_speaker": true,
"read_proficiency": "H",
"speak_proficiency": "H",
"translator": false,
"write_proficiency": "H"
}
]
,
"languages_saved": 2,
"maximum_allowed": 99,
"warnings": [
"Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know"
]
}
}
}
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.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

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

language_options: object

description: string
required: boolean
default: boolean

LanguageService: object

Person Language Service: object
resource: resource
request: request
response: response

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

proficiency_table: object

description: string
required: boolean
values: object[]
object
code: string
description: string
default: string

request: object

method: string
resource: string
attributes: string
status: string

resource: object

methods: object
options: string[]
string
adaptations: object[]
object
PUT: string[]
string
DELETE: string
URI: string
examples: string[]
string
identifiers: object
personid: object
description: string
required: boolean
default: string
language_code: object
description: string
required: boolean
conditions: string
service: string
attributes: object
speak_proficiency: proficiency_table
read_proficiency: proficiency_table
write_proficiency: proficiency_table
native_speaker: language_options
translator: language_options

response: object

languages_saved: integer
maximum_allowed: integer
Languages: object[]
object
language_code: string
description: string
speak_proficiency: string
read_proficiency: string
write_proficiency: string
native_speaker: boolean
translator: boolean
warnings: string[]
string
Service Path: 
/domains/legacy/identity/person/language
Domain or University API: 
/domains/D/identity/person/language

Community

 

Don't see your question listed here? Ask!