CRM360° CustomerApi Documentation

CustomerApi Odata Help Page

OData (http://www.odata.org/) is a standardized protocol built over existing HTTP and REST protocols supporting CRUD (Create, Read, Update, Delete) operations for creating and consuming data APIs.
We access an OData service via an URI like https://customerapi.fts-crm360.com/data/Contacts() using HttpMethod GET.
That request will return all the contact entities.
You have to specify Http Headers (X-Crm360Api-Token, X-Crm360Api-CustomerName, X-Crm360Api-DatabaseAlias) to allow the api to return results.
To access a particular entity, you can refer the entity key in the URI to access the particular record like https://customerapi.fts-crm360.com/data/Contacts(132). The contact key here is 132.

The below lines will document the most used and helpful queries when dealing with an OData service:
- $format : By default the data returned is in an XML feed. This query allows you to change the format of data. https://customerapi.fts-crm360.com/data/Contacts()?$format=json
- $top : This query option helps to limit the data returned by the service. https://customerapi.fts-crm360.com/data/contacts()?$top=3
- $skip : This can be treated as the opposite of $top. The skip queries can be used to skip records. https://customerapi.fts-crm360.com/data/Contacts()?$skip=2
- $inlinecount : This will return the total number of records without the filter as part of the response payload. https://customerapi.fts-crm360.com/data/Contacts()?$inlinecount=allpages
- $orderby : Use this to sort the records returned by the service. https://customerapi.fts-crm360.com/data/contacts()?$orderby=FirstName desc
- $expand : Expand related data inline with the results. Say, in case you want to return all the PurchaseGoods along with their PurchaseGoodCategory, use the following URL. https://customerapi.fts-crm360.com/data/PurchaseGoods()?$expand=PurchaseGoodCategory
- $filter : This can be compared to the 'where' query in SQL. Lets say we want to get all the PurchaseGoods with PurchaseGoodCategoryId equals to 3, then use https://customerapi.fts-crm360.com/data/PurchaseGoods()?$filter=PurchaseGoodCategoryId eq 3
- $select : As in any SQL query, this query option can be used to Select specific or all fields of an Entity set or entity. https://customerapi.fts-crm360.com/data/PurchaseGoods()?$select=SKU, LongName

For more documentation on Odata protocol visit http://www.odata.org/.

Customer

Entity Name Method Functions Api Description
Addresses GET
  • Create
  • Read
  • Update
  • Delete
/data/Addresses() Manage contact's address entities. An address entity is composed of postal address, email, mobile email, home phone and mobile phone.
AttachedStores GET
  • Create
  • Read
  • Delete
/data/AttachedStores() Manage the stores attached to contacts for the current user's allowed zones.
AttachedStoreTypes GET
  • Read
/data/AttachedStoreTypes() Manage the types of attached stores.
AttachedStoreTypeTranslations GET
  • Read
/data/AttachedStoreTypeTranslations() Manage the attachedStoreType translations.
Brands GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Brands() Manage the brands entities allowed for the current user.
BrandTranslations GET
  • Read
/data/BrandTranslations() Manage the brand translations.
Cases GET
  • Create
  • Read
  • Update
  • Delete
/data/Cases() Manage the cases linked to contacts for the current user's allowed zones.
CaseCategories GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/CaseCategories() Manage the categories of case entities.
CaseCategoryTranslations GET
  • Read
/data/CaseCategoryTranslations() Manage the case category translations.
CaseChannels GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/CaseChannels() Manage the channels of case entities.
CaseChannelTranslations GET
  • Read
/data/CaseChannelTranslations() Manage the case channel translations.
CaseStates GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/CaseStates() Manage the states of case entities.
CaseStateTranslations GET
  • Read
/data/CaseStateTranslations() Manage the case state translations.
CaseTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/CaseTypes() Manage the types of entities.
CaseTypeTranslations GET
  • Read
/data/CaseTypeTranslations() Manage the case type translations.
Channels GET
  • Read
  • Translate
/data/Channels() Manage the channel entities (Email, Postal Address, Sms,...)
ChannelTranslations GET
  • Read
/data/ChannelTranslations() Manage the case channel translations.
Civilities GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Civilities() Manage the contact's civility entities.
CivilityTranslations GET
  • Read
/data/CivilityTranslations() Manage the civility translations.
Contacts GET
  • Create
  • Read
  • Update
  • Delete
/data/Contacts() Manage contact entities excepting addresses (Cf Address entity)
ContactAddressTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/ContactAddressTypes() Manage the contact address types entities.
ContactAddressTypeTranslations GET
  • Read
/data/ContactAddressTypeTranslations() Manage contact address types translations.
ContactIdentifiers GET
  • Create
  • Read
  • Update
  • Delete
/data/ContactIdentifiers() Manage the contact identifier entities for the current user's allowed zones. Each contact can have O, 1 or many identifiers.
ContactInterestCategories GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/ContactInterestCategories() Manage the contact interest category entities.
ContactInterestCategoryTranslations GET
  • Read
/data/ContactInterestCategoryTranslations() Manage contact interest category translations.
ContactInterests GET
  • Create
  • Read
  • Update
  • Delete
/data/ContactInterests() Manage the contact interest entities for the current user's allowed zones.
ContactLinks GET
  • Create
  • Read
  • Update
  • Delete
/data/ContactLinks() Manage the links between 2 contacts entities.
ContactLinkTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/ContactLinkTypes() Manage the types of link between 2 contact entities.
ContactLinkTypeTranslations GET
  • Read
/data/ContactLinkTypeTranslations() Manage types of contact link translations.
ContactStates GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/ContactStates() Manage the contact's state entities.
ContactStateTranslations GET
  • Read
/data/ContactStateTranslations() Manage contact's state translations.
ContactTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/ContactTypes() Manage the contact's type entities.
ContactTypeTranslations GET
  • Read
/data/ContactTypeTranslations() Manage contact's type translations.
Countries GET
  • Read
  • Translate
/data/Countries() Manage the country entities.
CountryTranslations GET
  • Read
/data/CountryTranslations() Manage country translations.
Currencies GET
  • Read
  • Translate
/data/Currencies() Manage the currency entities.
CurrencyTranslations GET
  • Read
/data/CurrencyTranslations() Manage currency translations.
DiscountTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/DiscountTypes() Manage the discount type entities.
DiscountTypeTranslations GET
  • Read
/data/DiscountTypeTranslations() Manage discount type tanslations.
EmailStates GET
  • Read
  • Translate
/data/EmailStates() Manage the email state entities.
EmailStateTranslations GET
  • Read
/data/EmailStateTranslations() Manage email state translations.
Genders GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Genders() Manage the gender entities.
GenderTranslations GET
  • Read
/data/GenderTranslations() Manage gender translations.
HomePhoneStates GET
  • Read
  • Translate
/data/HomePhoneStates() Manage the home phone state entities.
HomePhoneStateTranslations GET
  • Read
/data/HomePhoneStateTranslations() Manage home phone state translations.
Languages GET
  • Read
  • Translate
/data/Languages() Manage the language entities.
LanguageTranslations GET
  • Read
/data/LanguageTranslations() Manage language translations.
LoyaltyCards GET
  • Create
  • Read
  • Update
  • Delete
/data/LoyaltyCards() LoyaltyCard entities
LoyaltyCardActions GET
  • Create
  • Read
  • Update
  • Delete
/data/LoyaltyCardActions() LoyaltyCardAction entities
LoyaltyCardActionTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/LoyaltyCardActionTypes() LoyaltyCardActionType entities
LoyaltyCardActionTypeTranslations GET
  • Read
/data/LoyaltyCardActionTypeTranslations() LoyaltyCardActionTypeTranslation entities
LoyaltyCardCodeTypes GET
  • Create
  • Read
  • Update
  • Delete
/data/LoyaltyCardCodeTypes() LoyaltyCardCodeType entities
LoyaltyCardStates GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/LoyaltyCardStates() LoyaltyCardState entities
LoyaltyCardStateTranslations GET
  • Read
/data/LoyaltyCardStateTranslations() LoyaltyCardStateTranslation entities
LoyaltyCardTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/LoyaltyCardTypes() LoyaltyCardType entities
LoyaltyCardTypeTranslations GET
  • Read
/data/LoyaltyCardTypeTranslations() LoyaltyCardTypeTranslation entities
LoyaltyPoints GET
  • Create
  • Read
  • Update
  • Delete
/data/LoyaltyPoints() LoyaltyPoint entities
LoyaltyPointTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/LoyaltyPointTypes() LoyaltyPointType entities
LoyaltyPointTypeTranslations GET
  • Read
/data/LoyaltyPointTypeTranslations() LoyaltyPointTypeTranslation entities
MaritalStatuses GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/MaritalStatuses() MaritalStatus entities
MaritalStatusTranslations GET
  • Read
/data/MaritalStatusTranslations() MaritalStatusTranslation entities
MarketingActions GET
  • Read
/data/MarketingActions() MarketingAction entities
MarketingActionTypes GET
  • Read
  • Translate
/data/MarketingActionTypes() MarketingActionType entities
MarketingActionTypeTranslations GET
  • Read
/data/MarketingActionTypeTranslations() MarketingActionTypeTranslation entities
MarketingExecutions GET
  • Read
/data/MarketingExecutions() MarketingExecution entities
MarketingExecutionTypes GET
  • Read
  • Translate
/data/MarketingExecutionTypes() MarketingExecutionType entities
MarketingExecutionTypeTranslations GET
  • Read
/data/MarketingExecutionTypeTranslations() MarketingExecutionTypeTranslation entities
MarketingHyperlinks GET
  • Read
/data/MarketingHyperlinks() MarketingHyperlink entities
MarketingMessages GET
  • Read
/data/MarketingMessages() MarketingMessage entities
MarketingParticipants GET
  • Read
/data/MarketingParticipants() MarketingParticipant entities
MarketingParticipantStates GET
  • Read
  • Translate
/data/MarketingParticipantStates() MarketingParticipantState entities
MarketingParticipantStateTranslations GET
  • Read
/data/MarketingParticipantStateTranslations() MarketingParticipantStateTranslation entities
MarketingReactions GET
  • Read
/data/MarketingReactions() MarketingReaction entities
MarketingReactionTypes GET
  • Read
  • Translate
/data/MarketingReactionTypes() MarketingReactionType entities
MarketingReactionTypeTranslations GET
  • Read
/data/MarketingReactionTypeTranslations() MarketingReactionTypeTranslation entities
MarketingScenarios GET
  • Read
/data/MarketingScenarios() MarketingScenario entities
MarketingScenarioTypes GET
  • Read
  • Translate
/data/MarketingScenarioTypes() MarketingScenarioType entities
MarketingScenarioTypeTranslations GET
  • Read
/data/MarketingScenarioTypeTranslations() MarketingScenarioTypeTranslation entities
MobilePhoneStates GET
  • Read
  • Translate
/data/MobilePhoneStates() MobilePhoneState entities
MobilePhoneStateTranslations GET
  • Read
/data/MobilePhoneStateTranslations() MobilePhoneStateTranslation entities
Nationalities GET
  • Read
  • Translate
/data/Nationalities() Nationality entities
NationalityTranslations GET
  • Read
/data/NationalityTranslations() NationalityTranslation entities
PostalAddressStates GET
  • Read
  • Translate
/data/PostalAddressStates() PostalAddressState entities
PostalAddressStateTranslations GET
  • Read
/data/PostalAddressStateTranslations() PostalAddressStateTranslation entities
PurchaseDetails GET
  • Create
  • Read
  • Update
  • Delete
/data/PurchaseDetails() PurchaseDetail entities
PurchaseGoods GET
  • Create
  • Read
  • Update
  • Delete
/data/PurchaseGoods() PurchaseGood entities
PurchaseGoodCategories GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/PurchaseGoodCategories() PurchaseGoodCategory entities
PurchaseGoodCategoryTranslations GET
  • Read
/data/PurchaseGoodCategoryTranslations() PurchaseGoodCategoryTranslation entities
PurchaseGoodTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/PurchaseGoodTypes() PurchaseGoodType entities
PurchaseGoodTypeTranslations GET
  • Read
/data/PurchaseGoodTypeTranslations() PurchaseGoodTypeTranslation entities
PurchaseHeaders GET
  • Create
  • Read
  • Update
  • Delete
/data/PurchaseHeaders() PurchaseHeader entities
PurchaseStatuses GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/PurchaseStatuses() PurchaseStatus entities
PurchaseStatusTranslations GET
  • Read
/data/PurchaseStatusTranslations() PurchaseStatusTranslation entities
PurchaseTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/PurchaseTypes() PurchaseType entities
PurchaseTypeTranslations GET
  • Read
/data/PurchaseTypeTranslations() PurchaseTypeTranslation entities
Segments GET
  • Create
  • Read
  • Update
  • Delete
/data/Segments() Manage the segments linked to contacts for the current user's allowed zones.
Segmentations GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Segmentations() Manage the segment types entities.
SegmentTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/SegmentTypes() Manage the segment types entities.
Sources GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Sources() Source entities
SourceTranslations GET
  • Read
/data/SourceTranslations() SourceTranslation entities
Stores GET
  • Create
  • Read
  • Delete
/data/Stores() Manage the stores attached to contacts for the current user's allowed zones.
StoreStates GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/StoreStates() StoreState entities
StoreStateTranslations GET
  • Read
/data/StoreStateTranslations() StoreStateTranslation entities
StoreTypes GET
  • Read
/data/StoreTypes() Manage the types of attached stores.
StoreTypeTranslations GET
  • Read
/data/StoreTypeTranslations() Manage the attachedStoreType translations.
Titles GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Titles() Title entities
TitleTranslations GET
  • Read
/data/TitleTranslations() TitleTranslation entities
Vouchers GET
  • Create
  • Read
  • Update
  • Delete
/data/Vouchers() Voucher entities
VoucherCategories GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/VoucherCategories() Manage the categories of voucher entities.
VoucherCategoryTranslations GET
  • Read
/data/VoucherCategoryTranslations() Manage the case category translations.
VoucherStates GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/VoucherStates() VoucherState entities
VoucherStateTranslations GET
  • Read
/data/VoucherStateTranslations() VoucherStateTranslation entities
VoucherTypes GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/VoucherTypes() VoucherType entities
VoucherTypeTranslations GET
  • Read
/data/VoucherTypeTranslations() VoucherTypeTranslation entities
Zones GET
  • Create
  • Read
  • Update
  • Delete
  • Translate
/data/Zones() Zone entities
ZoneTranslations GET
  • Read
/data/ZoneTranslations() ZoneTranslation entities