IdentityOrganizationOrgInfo

OrgInfoService

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

Base URL: /domains/legacy/identity/organization/orginfo

Version: v1

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

Summary

Path Operation Description
/* PUT

Adds a new organization in PRO

/documentation GET

service definition

/lookup* GET

Lookup organizations

/{person_id} GET

Gets organization information

PUT

Updates an existing organization in PRO

Paths

Adds a new organization in PRO

PUT /*

Tags: OrgInfoService

Adds a new organization in PRO

organization_name

string ->

query string
responsible_department

string ->

query string
organization_type

string ->

query string
responsible_person_id

string ->

query string

Uses default content-types: application/json

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.

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.

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Lookup organizations

GET /lookup*

Tags: OrgInfoService

Lookup organizations

responsible_person_id

string ->

query string
person_id

string ->

query string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"OrgInfoService": {
"request": {
"attributes": "responsible_person_id=123456789&person_id=123456789",
"method": "GET",
"resource": "/lookup",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"organizations": [
{
"name": "regcart",
"organization_type": "Department",
"person_id": "987654321",
"responsible_department": "OIT-App Dev Student Info Mgmt",
"responsible_person": {
"responsible_person_department": "OIT-App Dev Student Info Mgmt / Office Information Technology",
"responsible_person_id": "123456789",
"responsible_person_job_title": "Software Developer",
"responsible_person_sort_name": "Doe, John A"
}
}
]
}
}
}
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.

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.

Gets organization information

GET /{person_id}

Tags: OrgInfoService

Gets organization information

person_id

an organization id

path string

Uses default content-types: application/json

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.

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.

Updates an existing organization in PRO

PUT /{person_id}

Tags: OrgInfoService

Updates an existing organization in PRO

person_id

string -> the id of an organization

path string

Uses default content-types: application/json

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.

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

docErrors: object[]

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

documentation: object

WebService: object
name: string
operations: operations
docErrors: docErrors
httpStatusCodes: httpStatusCodes

httpStatusCodes: object[]

object
code: integer
message: 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

OrgInfo: object

OrgInfoService: object
request: request
response: response

request: object

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

response: object

organizations: object[]
object
name: string
person_id: string
responsible_department: string
organization_type: string
responsible_person: object
responsible_person_id: string
responsible_person_sort_name: string
responsible_person_job_title: string
responsible_person_department: string
Service Path: 
/domains/legacy/identity/organization/orginfo
Domain or University API: 
/domains/D/identity/organization/orginfo

Community

 

Don't see your question listed here? Ask!