regis

<back to all web services

PersonRestrictionsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Person/{uuid}/Restrictions
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PersonRestrictionResponse() = 
        member val id:Int32 = new Int32() with get,set
        member val restriction_code:String = null with get,set
        member val restriction_description:String = null with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type RestrictionResponse() = 
        member val id:Int32 = new Int32() with get,set
        member val restriction_code:String = null with get,set
        member val restriction_description:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PersonRestrictionsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val restrictions:ResizeArray<PersonRestrictionResponse> = new ResizeArray<PersonRestrictionResponse>() with get,set
        member val valid_restrictions:ResizeArray<RestrictionResponse> = new ResizeArray<RestrictionResponse>() with get,set

    [<AllowNullLiteral>]
    type PersonRestrictionsRequest() = 
        member val uuid:String = null with get,set

F# PersonRestrictionsRequest DTOs

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}]}