Difference between revisions of "API: Selecting Specific Fields"
| Line 5: | Line 5: | ||
When you hit an endpoint, a range of default fields are automatically returned. If you want something that isn't default, or you want to return less data to speed things up, you can pick the fields to be returned. In the case of referrals or clients you can also return any single record extension databases. Use /field/ with semicolon separated field names to choose the fields you want to return. | When you hit an endpoint, a range of default fields are automatically returned. If you want something that isn't default, or you want to return less data to speed things up, you can pick the fields to be returned. In the case of referrals or clients you can also return any single record extension databases. Use /field/ with semicolon separated field names to choose the fields you want to return. | ||
| − | '[GET] https://api.dizions.co.uk/clients/field/id;surname;website_photo_consent | + | '[GET] https<nowiki/>://api.dizions.co.uk/clients/field/id;surname;website_photo_consent |
The API can tell you which fields are available by appending /selectable_fields to the group. | The API can tell you which fields are available by appending /selectable_fields to the group. | ||
| − | [GET] https://api.dizions.co.uk/v2/clients/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/selectable_fields |
| − | [GET] https://api.dizions.co.uk/v2/workers/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/workers/selectable_fields |
| − | [GET] https://api.dizions.co.uk/v2/referrals/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/selectable_fields |
| − | [GET] https://api.dizions.co.uk/v2/due_contacts/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/due_contacts/selectable_fields |
| − | [GET] https://api.dizions.co.uk/v2/done_contacts/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/selectable_fields |
| − | [GET] https://api.dizions.co.uk/v2/schedules/selectable_fields | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/schedules/selectable_fields |
---- | ---- | ||
Revision as of 13:03, 13 May 2020
When you hit an endpoint, a range of default fields are automatically returned. If you want something that isn't default, or you want to return less data to speed things up, you can pick the fields to be returned. In the case of referrals or clients you can also return any single record extension databases. Use /field/ with semicolon separated field names to choose the fields you want to return.
'[GET] https://api.dizions.co.uk/clients/field/id;surname;website_photo_consent
The API can tell you which fields are available by appending /selectable_fields to the group.
[GET] https://api.dizions.co.uk/v2/clients/selectable_fields
[GET] https://api.dizions.co.uk/v2/workers/selectable_fields
[GET] https://api.dizions.co.uk/v2/referrals/selectable_fields
[GET] https://api.dizions.co.uk/v2/due_contacts/selectable_fields
[GET] https://api.dizions.co.uk/v2/done_contacts/selectable_fields
[GET] https://api.dizions.co.uk/v2/schedules/selectable_fields
