AcademicControlsSAASMetrics

In order to execute this web service, you must use one of OIT's methods (Web Services Session or Trusted Partner) to authenticate.

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

Base URL: /domains/legacy/academic/controls/SAASmetrics

Version: v1

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

Summary

Path Operation Description
/ POST

Save Saas Metrics

/customerId/{customer_person_id} GET

Get metrics for given customer id

/documentation GET

service definition

/metricId/{metric_id} GET

Get metrics for given metric id

/{metric_type}/{type_id} GET

Get metrics for given id and type

Paths

Save Saas Metrics

POST /

Tags: SaasMetricsService

Save Saas Metrics

metric_type

string ->

query string
type_id

string ->

query 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.

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.

Get metrics for given customer id

GET /customerId/{customer_person_id}

Tags: SaasMetricsService

Get metrics for given customer id

customer_person_id

string ->

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.

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 application/xml

200 OK

Success

Get metrics for given metric id

GET /metricId/{metric_id}

Tags: SaasMetricsService

Get metrics for given metric id

metric_id

string ->

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.

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.

Get metrics for given id and type

GET /{metric_type}/{type_id}

Tags: SaasMetricsService

Get metrics for given id and type

metric_type

string ->

path string
type_id

string ->

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.

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

Service Path: 
/domains/legacy/academic/controls/SAASmetrics
Domain or University API: 
/domains/D/academic/controls/SAASmetrics

Community

 

Don't see your question listed here? Ask!