regis

<back to all web services

OrganizationRequest

Requires Authentication
Required permission:SearchOrganization
The following routes are available for this service:
POST/organization/{organization_id}
OrganizationRequest Parameters:
NameParameterData TypeRequiredDescription
organization_idpathintNo
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
organization_idformintNo
organization_nameformstringNo
emailformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
phone_cellformstringNo
phone_busformstringNo
phone_homeformstringNo
is_institutionformboolNo
is_vendorformboolNo
is_reformboolNo

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<OrganizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <organization_id>0</organization_id>
</OrganizationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrganizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <email>String</email>
  <is_institution>false</is_institution>
  <is_re>false</is_re>
  <is_vendor>false</is_vendor>
  <organization_id>0</organization_id>
  <organization_name>String</organization_name>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <state>String</state>
</OrganizationResponse>