regis

<back to all web services

PersonRestrictionsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Person/{uuid}/Restrictions
PersonRestrictionsRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
PersonRestrictionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
restrictionsformList<PersonRestrictionResponse>No
valid_restrictionsformList<RestrictionResponse>No
PersonRestrictionResponse Parameters:
NameParameterData TypeRequiredDescription
idformintNo
restriction_codeformstringNo
restriction_descriptionformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
RestrictionResponse Parameters:
NameParameterData TypeRequiredDescription
idformintNo
restriction_codeformstringNo
restriction_descriptionformstringNo
is_activeformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Person/{uuid}/Restrictions HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"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,"uuid":"String","restrictions":[{"id":0,"restriction_code":"String","restriction_description":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"valid_restrictions":[{"id":0,"restriction_code":"String","restriction_description":"String","is_active":false}]}