regis

<back to all web services

OrganizationRequest

Requires Authentication
Required permission:SearchOrganization
The following routes are available for this service:
POST/organization/{organization_id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrganizationResponse:
    response_status: Optional[ResponseStatus] = None
    organization_id: int = 0
    organization_name: Optional[str] = None
    email: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    phone_cell: Optional[str] = None
    phone_bus: Optional[str] = None
    phone_home: Optional[str] = None
    is_institution: bool = False
    is_vendor: bool = False
    is_re: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrganizationRequest:
    organization_id: int = 0

Python OrganizationRequest 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 /organization/{organization_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"organization_id":0}
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"}},"organization_id":0,"organization_name":"String","email":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","phone_cell":"String","phone_bus":"String","phone_home":"String","is_institution":false,"is_vendor":false,"is_re":false}