Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing corporation contact labels endpoint #779

Closed
dextermb opened this issue Mar 1, 2018 · 11 comments
Closed

Missing corporation contact labels endpoint #779

dextermb opened this issue Mar 1, 2018 · 11 comments

Comments

@dextermb
Copy link

dextermb commented Mar 1, 2018

Feature request

I would like to be able to return labels, on contacts, for a corporation. (There also does not seem to be POST, PUT, DELETE methods for corporation contacts)

Route

The route should follow the same pattern as the character endpoint (/characters/{character_id}/contacts/labels):

/corporations/{corporation_id}/contacts/labels

Authentication

Not sure what authentication characters use for labels but seems reasonable:

esi-corporations.read_contacts.v1

Use case

This endpoint would be used to return labels that are assigned to a contact, of a corporation, to be displayed in one way or another.

Example returns

It should be returned in the same format as the character contact labels endpoint.


[
    {
        label_id: int,
        label_name: string
    }
]

@CarbonAlabel
Copy link
Member

This should be part of parity work, as the XML API endpoint /char/ContactList.xml.aspx provides a list of corporation, as well as alliance contact labels.

Closely related to this are issues #173 (regarding write access to contact labels) and #174 (a bug/inconsistency with the return format of a contact's labels).

@warlof
Copy link
Contributor

warlof commented Mar 13, 2018

up

actually corporation contacts are not sortable due to the lack of this endpoint :(

@warlof
Copy link
Contributor

warlof commented Apr 4, 2018

any ETA about that missing endpoint creation ?

@ccp-zoetrope
Copy link
Contributor

I'm starting to look into this today so I'll let you know once I've dug in a bit.

@ccp-zoetrope ccp-zoetrope added the in-progress Issue is being worked on by a developer. label Apr 5, 2018
@ccp-zoetrope ccp-zoetrope added in-staging A solution for this issue is ready, and is waiting to be deployed. and removed in-progress Issue is being worked on by a developer. labels Apr 13, 2018
@ccp-zoetrope
Copy link
Contributor

I'm sorry to say I found a bug in the deployed code for this in the monolith and have fixed it, but that means it will not be available until next week :(

@warlof
Copy link
Contributor

warlof commented Apr 21, 2018

@ccp-zoetrope can you disclose the endpoint structure ? so we can work on our jobs ? :/

@ccp-zoetrope
Copy link
Contributor

Sure, there will be two new endpoints, /v1/corporations/{corporation_id}/contacts/labels/ and /v1/alliances/{alliance_id}/contacts/labels/ which literally have the same structure as /v1/characters/{character_id}/contacts/labels/.

The other change happening for this whole thing will be the addition of /v2/corporations/{corporation_id}/contacts/, /v2/characters/{character_id}/contacts/, and /v2/alliances/{alliance_id}/contacts/ which will return an array of label_ids instead of label_id so that it's not necessary for the developer to figure out the bitmasking going on in these endpoints.

Here is the swagger spec for label_ids:

                            label_ids:
                                type: array
                                maxItems: 63
                                items:
                                    type: integer
                                    format: int64
                                    description: >-
                                        Label IDs applied to the contact.

@warlof
Copy link
Contributor

warlof commented Apr 23, 2018

I assume the same thing apply to the new corporation endpoints related to label_ids ?
Thank you zoetrope :)

@ccp-zoetrope
Copy link
Contributor

@warlof which corporation endpoints are you referring to specifically?

@warlof
Copy link
Contributor

warlof commented Apr 25, 2018

I was talking about /v2/corporations/{corporation_id}/contacts/

But self explained ^^
I didn't notice.

@ccp-zoetrope
Copy link
Contributor

New routes deployed today:
GET /v1/alliances/{alliance_id}/contacts/labels/
GET /v1/corporations/{corporation_id}/contacts/labels/

Full changelist available here

@ccp-zoetrope ccp-zoetrope removed the in-staging A solution for this issue is ready, and is waiting to be deployed. label Apr 26, 2018
leonjza pushed a commit to eveseat/eveapi that referenced this issue Apr 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants