-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAccounts.yaml
142 lines (140 loc) · 4.7 KB
/
Accounts.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
openapi: 3.0.3
info:
title: SalesSparrow Accounts API's
description: Following api's will be called from the SalesSparrow application
version: '1.0'
servers:
- url: https://sales.truesparrow.com/api
paths:
/v1/accounts:
get:
description: Api will return the list of accounts
parameters:
- name: q
in: query
description: Account Search String
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
account_ids:
type: array
description: List of account IDs
items:
type: string
example: "abc1234abc"
account_map_by_id:
type: object
description: Map of accounts by ID
properties:
"abc1234abc":
type: object
properties:
$ref: 'Components.yaml#/components/schemas/account'
'400':
description: "Bad Request"
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_400'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_401'
'404':
description: Not Found
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_404'
'500':
description: Something went wrong
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_500'
/v1/accounts/feed:
get:
description: Api will return the paginated account feed details
parameters:
- name: pagination_identifier
in: query
required: true
schema:
type: string
example: "xyz"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
account_ids:
type: array
description: List of account IDs
items:
type: string
example: "abc1234abc"
account_map_by_id:
type: object
description: Map of accounts by ID
properties:
"abc1234abc":
type: object
properties:
$ref: 'Components.yaml#/components/schemas/account'
contact_map_by_id:
type: object
description: Map of contacts by ID
properties:
"abcd1234abcd":
type: object
properties:
$ref: 'Components.yaml#/components/schemas/contact'
account_contact_associations_map_by_id:
type: object
description: Map of account contact associations by ID
properties:
"abc1234abc":
type: object
properties:
$ref: 'Components.yaml#/components/schemas/account_contact_association'
next_page_payload:
type: object
properties:
$ref: 'Components.yaml#/components/schemas/next_page_payload'
'400':
description: "Bad Request"
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_400'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_401'
'404':
description: Not Found
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_404'
'500':
description: Something went wrong
content:
application/json:
schema:
$ref: 'Components.yaml#/components/schemas/response_500'