/v3/WSAPIService.svc/CompanyGetByShortName (Method)

Method

/v3/WSAPIService.svc/CompanyGetByShortName

In This Topic

Description

Retrieves a Company entity for a specific company short name.

Request (WSAPIServiceContract_CompanyGetByShortName_InputMessage)

The request body is of type CompanyGetByShortName.

Request Body Parameters

Name	Description	Data Type
Request	Message request object containing the company short name for the company data to return.	CompanyGetByShortNameRequest

Overview

CompanyGetByShortName

Sequence

Request optional CompanyGetByShortNameRequest Complex Type

Message request object containing the company short name for the company data to return.

Sequence

CompanyShortName optional xs:string

Search by short name.

Response (WSAPIServiceContract_CompanyGetByShortName_OutputMessage)

The response body is of type CompanyGetByShortNameResponse.

Response Body Parameters

Name	Description	Data Type
CompanyGetByShortNameResult	Message response object containing company data matching the requested company short name.	CompanyGetByShortNameResponse

Overview

CompanyGetByShortNameResponse

Sequence

CompanyGetByShortNameResult optional CompanyGetByShortNameResponse Complex Type

Message response object containing company data matching the requested company short name.

Sequence

Company optional Company Complex Type

Collection of company entities matching the selection criteria.

Sequence

CompanyCode optional xs:string

Unique identifier for a company.

Uniqueness is maintained in AMS360.

IsInactive optional xs:boolean

Flag indicating whether the company is active (false) or inactive (true).

NAICCompanyCode optional xs:string

National Association of Insurance Commissioners (NAIC) company code. This code uniquely identifies insurance companies.

The company code and NAIC company code combination must be unique.

Name optional xs:string

Name of insurance, finance, brokerage, fee or writing company.

Duplicate names are not allowed across company types with the exception of writing company names. Writing companies can be the same as long as they have different parent companies.

ParentCompanyCode optional xs:string

Unique identifier of a company or holding company (parent company) that owns or is affiliated with other companies. If the company type is a writing company (a subsidiary company of a parent company), this field identifies the parent company associated with the writing company. For all other company types it will be the same as the company code.

ShortName optional xs:string

Identifier for a company. This displayable code is entered and maintained by the agency.

Company short name can be duplicated across company types (insurance, brokerage, finance, and fee) and within company type if company type is brokerage, finance, or fee. Writing company short name can be duplicated across company types (insurance and brokerage) and within company type if company type is brokerage. Confirm company type when determining whether writing company or company short name is being used.

CompanyType optional xs:string

Indicates the type of company.

Code value from the "CompanyType" value list.

Valid values are:
E = Fee
F = Finance
S = Subscription
W = Writing
B = Brokerage
N = Insurance

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=CompanyType

Fault Responses

Fault	Description
WSAPISecurityFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_CompanyGetByShortName_WSAPISecurityFaultFault_FaultMessage.
WSAPIBusinessFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_CompanyGetByShortName_WSAPIBusinessFaultFault_FaultMessage.
WSAPIGeneralFaultFault	This fault returns a response body of type https://wsapi.ams360.com/v3.0:WSAPIServiceContract_CompanyGetByShortName_WSAPIGeneralFaultFault_FaultMessage.