regis

<back to all web services

CatalogsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Catalogs
CatalogsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
catalogsformList<CatalogResponse>No
CatalogResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
idformintNo
catalog_codeformstringNo

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 /Catalogs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
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"}},"catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}