Coruson API

<back to all web services

GetFieldBankFields

Coruson FieldBank Fields

Requires Authentication
GetFieldBankFields Parameters:
NameParameterData TypeRequiredDescription
FieldIdqueryGuidNoFilter by FieldBankField Id.
FieldNamequerystringNoFilter by the name of the FieldBank Field.
IsActivequeryBooleanFilterYesFilter by the status of the field.

Allowable Values

  • All
  • True
  • False
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
GetFieldBankFieldsResponse Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<FieldBankField>No
GetResponseBase Parameters:
NameParameterData TypeRequiredDescription
TotalResultsformintNo
SkipformintNo
TakeformintNo
LinksformList<Link>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo
Link Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RequestUrlformstringNo
MethodformstringNo
FieldBankField Parameters:
NameParameterData TypeRequiredDescription
FieldIdformGuidNo
FieldNameformstringNo
FieldTypeformFieldTypeNo
CollectionTypeformFieldCollectionTypeNo
CollectionIdformGuid?No
CollectionNameformstringNo
RepeaterSectionsformList<RepeaterSection>No
IsActiveformboolNo
RepeaterSection Parameters:
NameParameterData TypeRequiredDescription
SectionTemplateIdformGuidNo
SectionTemplateNameformstringNo

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

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /soap11 HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetFieldBankFields

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetFieldBankFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <FieldId>00000000-0000-0000-0000-000000000000</FieldId>
  <FieldName>String</FieldName>
  <IsActive>All</IsActive>
</GetFieldBankFields>

    </soap:Body>
</soap:Envelope>
                    
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetFieldBankFieldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
  <TotalResults>0</TotalResults>
  <Skip>0</Skip>
  <Take>0</Take>
  <Links>
    <Link>
      <Name>String</Name>
      <RequestUrl>String</RequestUrl>
      <Method>String</Method>
    </Link>
  </Links>
  <Fields>
    <FieldBankField>
      <FieldId>00000000-0000-0000-0000-000000000000</FieldId>
      <FieldName>String</FieldName>
      <FieldType>All</FieldType>
      <CollectionType>All</CollectionType>
      <CollectionId>00000000-0000-0000-0000-000000000000</CollectionId>
      <CollectionName>String</CollectionName>
      <RepeaterSections>
        <RepeaterSection>
          <SectionTemplateId>00000000-0000-0000-0000-000000000000</SectionTemplateId>
          <SectionTemplateName>String</SectionTemplateName>
        </RepeaterSection>
      </RepeaterSections>
      <IsActive>false</IsActive>
    </FieldBankField>
  </Fields>
</GetFieldBankFieldsResponse>

    </soap:Body>
</soap:Envelope>