SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    OData list of Persons under a specific ContactEntity.

    Can be sorted and further filtered using OData conventions:

    • Contact/1234/Persons?$select=col1,col2,abc/col3
    • Contact/1234/Persons?$filter=col1 eq 'foo' and startswith(col2, 'baz')
    • Contact/1234/Persons?$orderby=abc/col3,col1
    • Contact/1234/Persons?$top=1000
    • Contact/1234/Persons?$mode=full

    OData returns XML or JSON carriers depending on the HTTP Accept header.

    Calls the Archive service using the "Person" archive provider.

    Filter Operators:

    ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

    strings: contains, is, notBegins, notContains, isNot

    associate: associateIsOneOf, associateIsNotOneOf,

    list ids: oneOf, NotOneOf,

    dates: before, date, after, dateBetween, beforeToday

    Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

    Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)

    Input

    type: object properties: parameters: type: object properties: id: type: string description: The entity id $select: type: string description: >- Comma separated list of column names to return. "nameDepartment,fullname,category". Can also use aggregation functions and modifiers: "Count(category):Footer" $filter: type: string description: >- Expression to restrict the results. e.g.: "name begins 'foo' and category gt 1" $orderBy: type: string description: >- Comma separated list of column names to sort by, with optional direction. "name asc,fullname,category desc" $entities: type: string description: 'Comma separated list of entity names to use. e.g: "contact, person"' $top: type: string description: Number of rows to return in results $skip: type: string description: Number of rows from database to skip before returning results $mode: type: string description: >- FULL (with raw values and hints for each value) or SLIM (just the display values) $options: type: string description: 'Provider specific options. e.g: "GrandTotal=true"' $context: type: string description: Provider specific context parameter. $format: type: string description: >- Set XML or JSON output format; override the format determined from Accept header. $jsonSafe: type: string description: >- Make output names into JSON safe property names. Replace all unsafe characters with _ underscore. $output: type: string description: >- Return Logical or Display values in SLIM mode. Logical returns true/false for booleans, Display returns icon hints. Dates are always returned as ISO strings. Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - id title: Parameters