Required role: | REGISUserRole |
POST | /Person/{uuid}/Restrictions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
regent_id | form | int | No | |
uuid | form | string | No | |
restrictions | form | List<PersonRestrictionResponse> | No | |
valid_restrictions | form | List<RestrictionResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | int | No | |
restriction_code | form | string | No | |
restriction_description | form | string | No | |
start_date | form | DateTime? | No | |
end_date | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | int | No | |
restriction_code | form | string | No | |
restriction_description | form | string | No | |
is_active | form | bool | No |
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/{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}]}