Required role: | REGISUserRole |
POST | /person/keys |
---|
"use strict";
export class PersonKeyResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,re_id?:number,sugar_id?:string,uuid?:string,student_id?:number,regent_login?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {number} */
re_id;
/** @type {string} */
sugar_id;
/** @type {string} */
uuid;
/** @type {?number} */
student_id;
/** @type {string} */
regent_login;
}
export class PersonKeyRequest {
/** @param {{regent_id?:number,uuid?:string,regent_login?:string,regent_network_login?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {string} */
regent_login;
/** @type {string} */
regent_network_login;
}
JavaScript PersonKeyRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/keys HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"regent_id":0,"uuid":"String","regent_login":"String","regent_network_login":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"re_id":0,"sugar_id":"String","uuid":"String","student_id":0,"regent_login":"String"}