AdBookConnect Web Service
MethodGetAgencyList
AdBookConnect Web Service > All Operations Resource Group : GetAgencyList (Method)
Summary
Retrieves a list of all Agency objects.
Request (IAdBookConnect_GetAgencyList_InputMessage)

The request body is of type http://www.FatTail.com/api:GetAgencyList.

Overview

Sequence
200 Response (IAdBookConnect_GetAgencyList_OutputMessage)

The response body is of type http://www.FatTail.com/api:GetAgencyListResponse.

Response Body Parameters

NameDescriptionData Type
Collection of all Agency objects.http://www.FatTail.com/api:ArrayOfAgency

Overview

Sequence
GetAgencyListResult optional ArrayOfAgency Complex Type
Sequence
Sequence
Address optional xs:string
Number and street.
City optional xs:string
City element of the address.
Country optional xs:string
Country element of the address.
ExternalID optional xs:string
Third party system ID used for mapping external entities to AdBook clients and agencies.
Fax optional xs:string
Fax number for the client or agency.
Name xs:string
Name of the account entity.
Notes optional xs:string
Free form text field assigned to the account.
Phone optional xs:string
Phone number of the account.
PostalCode optional xs:string
Postal code for the account address.
State optional xs:string
State the account resides in.
URL optional xs:string
URL for the account.
CRMID optional xs:string
Mapping ID for a CRM entity if the Agency is associated with an entity in a CRM system.
IsCreditRisk optional xs:boolean
Flag to indicate credit status of the Agency.
ReadonlyProperties optional ArrayOfReadonlyPropertyValue Complex Type
Sequence
Sequence
PropertyName optional xs:string
Value optional xs:string
AgencyID optional xs:long
Primary key for the Agency.
CustomerCode optional xs:string
Third party system ID.  Usually used for mapping an Agency to the appropriate entity in a billing/invoicing system.
ParentAgencyID optional xs:long
Reference to the parent company of the Agency.  This will be the AgencyID of another Agency.
AgencyDynamicProperties optional ArrayOfDynamicPropertyValue Complex Type
User defined properties for the Agency.
Sequence
Sequence
DynamicPropertyID optional xs:long
AdBook system ID for the DynamicProperty.
Value optional xs:string
Value being assigned to the dynamic property.  The format of the value depends on the type specified in the DynamicProperty definition.
Fault Responses
FaultDescription
This fault returns a response body of type http://www.FatTail.com/api:IAdBookConnect_GetAgencyList_DataAccessFaultFault_FaultMessage.  
See Also
All Operations Resource GroupAdBookConnect Web Service